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

From The Coppermind
Jump to navigation Jump to search
(Created page with "<noinclude> Helper template to insert a required parameter row in an infobox template documentation page. {{docs|title=Documentation for a required row parameter}} </noinclud...")
 
m
Line 1: Line 1:
 
<noinclude>
 
<noinclude>
Helper template to insert a required parameter row in an infobox template documentation page.
+
Helper template to insert a required parameter row in an infobox template documentation page. It takes 3 parameters:
  +
* <code>param</code>: The name of the parameter being documented
  +
* <code>desc</code>: A description of how the parameter is to be used
  +
* <code>eg</code>: One or more usage examples
   
 
{{docs|title=Documentation for a required row parameter}}
 
{{docs|title=Documentation for a required row parameter}}

Revision as of 19:41, 19 April 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 row parameter
Parameter Description Examples
{{{param}}} {{{desc}}} {{{eg}}}

Usage