Difference between revisions of "Template:Docs/row/required"

From The Coppermind
Jump to navigation Jump to search
m
m (+cat)
Line 4: Line 4:
 
* <code>desc</code>: A description of how the parameter is to be used
 
* <code>desc</code>: A description of how the parameter is to be used
 
* <code>eg</code>: One or more usage examples
 
* <code>eg</code>: One or more usage examples
  +
  +
[[category: documentation templates]]
   
 
{{docs|title=Documentation for a required parameter}}
 
{{docs|title=Documentation for a required parameter}}

Revision as of 15:02, 18 August 2019

Helper template to insert a required parameter row in an infobox template documentation page. It takes 3 parameters:

  • param: The name of the parameter being documented
  • desc: A description of how the parameter is to be used
  • eg: One or more usage examples
Documentation for a required parameter
Parameter Description Examples
Unknown parameter {{{desc}}}

{{{eg}}}

Usage