Template:Improve documentation/doc

This is an old revision of this page, as edited by Redrose64 (talk | contribs) at 19:12, 6 January 2025 (Usage: add example of commonly-preceding code). The present address (URL) is a permanent link to this revision, which may differ significantly from the current revision.

Usage

For use on template/module documentation pages whose content is missing, insufficient, incomplete and/or inaccurate.

  • If the template already has a documentation subpage, place this template in that subpage before the first heading. Example:
    {{Documentation subpage}}
    {{Improve documentation|date=August 2025}}
    ==Usage==
  • If the template does not have a documentation subpage, place this template at the end of the main template code, wrapped in <noinclude>...</noinclude> tags. Example:
    ... main template code ...
    }}<noinclude>

    {{Improve documentation|date=August 2025}}
    </noinclude>

The template adds pages to Category:Templates with missing or incorrect documentation.

TemplateData

Tags templates with inadequate or nonexistent documentations.

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
Has details on talk pagetalk 1

Shows "See the talk page for details" if a value is supplied

Booleanoptional
Datedate

Date tagged

Auto value
{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}
Stringoptional


See also