Difference between revisions of "Template:Param"

From Kolmafia
Jump to navigation Jump to search
imported>StDoodle
m
imported>StDoodle
m
Line 2: Line 2:
 
<h2>Using Param</h2>
 
<h2>Using Param</h2>
 
<p>This is the template for a parameter; first supplied value is parameter ''type,'' second is parameter ''description.''</p>
 
<p>This is the template for a parameter; first supplied value is parameter ''type,'' second is parameter ''description.''</p>
<p>Note that the second parameter, ''description'', is optional. If used, it will be displayed styled by [[Template:Pspan]].</p>
+
<p>Note that the second parameter, ''description'', is optional. (If used, it will be displayed with automatic styling via [[Template:Pspan]].)</p>
 
<p>To specify that the return dataype is an aggregate, supply an additional argument of "ag=SOMETHING" where SOMETHING can be any string at all.</p>
 
<p>To specify that the return dataype is an aggregate, supply an additional argument of "ag=SOMETHING" where SOMETHING can be any string at all.</p>
 
<h2>Examples</h2>
 
<h2>Examples</h2>

Revision as of 15:41, 28 February 2010

Using Param

This is the template for a parameter; first supplied value is parameter type, second is parameter description.

Note that the second parameter, description, is optional. (If used, it will be displayed with automatic styling via Template:Pspan.)

To specify that the return dataype is an aggregate, supply an additional argument of "ag=SOMETHING" where SOMETHING can be any string at all.

Examples

{{Param|int|count}}

Produces:  int count 

{{Param|string}}

Produces:  string 

{{Param|int [string]|map|ag=t}}

Produces: int [string] map