Module:Utils/doc: Difference between revisions

(5 intermediate revisions by the same user not shown)

Line 1:

{{documentation|

This module provides several mathematical functions which are likely to be used frequently on the Xenharmonic Wiki.

Line 8:

; <code>trim(s)</code>

: Removes leading and trailing whitespaces (but not interior ones) from a string.

; <code>_yesno(frame)</code>

: Allows [[Module:Yesno]], which is not invokable directly, to be accessed by templates through [[Template:Yesno]].

; <code>table_contains(tbl, x)</code>*

Line 18:

Line 21:

: Checks if <code>s</code> is a non-empty string.

; <code>eval_num_arg(input, def_value)</code>*

; <code>wlink(a, b)</code>

: Provides a link to Wikipedia.

; <code>eval_num_arg(input, def_value)</code>*

: Checks if <code>input</code> is a number; on error, use <code>def_value</code>.

Line 46:

Line 52:

; <code>next_young_diagram(d)</code>

: Returns the next Young diagram of the same size; the first one is <code>[N]</code>, the last one is <code>[1, 1, ..., 1]</code>. After the last one, <code>nil</code> is returned. The input table is modified.

: Returns the next Young diagram of the same size; the first one is <code>[N]</code>, the last one is <code>{{nowrap|[1, 1, ..., 1]}}</code>. After the last one, <code>nil</code> is returned. The input table is modified.

<nowiki />* These functions are designed to be used by other modules only; they cannot be called with <code>{{<nowiki />#invoke: }}</code>.

}}

@@ Line 1: / Line 1: @@
 {{documentation|
-{{dochead|header=none}}
+{{dochead|header=none}}{{lua|Arguments|yesno}}
 This module provides several mathematical functions which are likely to be used frequently on the Xenharmonic Wiki.
@@ Line 8: / Line 8: @@
 ; <code>trim(s)</code>
 : Removes leading and trailing whitespaces (but not interior ones) from a string.
+; <code>_yesno(frame)</code>
+: Allows [[Module:Yesno]], which is not invokable directly, to be accessed by templates through [[Template:Yesno]].
 ; <code>table_contains(tbl,&nbsp;x)</code>*
@@ Line 18: / Line 21: @@
 : Checks if <code>s</code> is a non-empty string.
-; <code>eval_num_arg(input, def_value)</code>*
+; <code>wlink(a, b)</code>
+: Provides a link to Wikipedia.
+; <code>eval_num_arg(input,&nbsp;def_value)</code>*
 : Checks if <code>input</code> is a number; on error, use <code>def_value</code>.
@@ Line 46: / Line 52: @@
 ; <code>next_young_diagram(d)</code>
-: Returns the next Young diagram of the same size; the first one is <code>[N]</code>, the last one is <code>[1, 1, ..., 1]</code>. After the last one, <code>nil</code> is returned. The input table is modified.
+: Returns the next Young diagram of the same size; the first one is <code>[N]</code>, the last one is <code>{{nowrap|[1, 1, ..., 1]}}</code>. After the last one, <code>nil</code> is returned. The input table is modified.
 <nowiki />* These functions are designed to be used by other modules only; they cannot be called with <code>{{<nowiki />#invoke:&nbsp;}}</code>.
 }}