Module:Utils/doc: Difference between revisions

(7 intermediate revisions by 2 users not shown)

Line 13:

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

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

: Wrapper function for [[Module: Yesno]], for use with templates. (Module: Yesno does not have a corresponding template.)

; <code>_clamp(~~val~~, ~~min_val~~, ~~max_val~~)</code>

; <code>_clamp(value, min_value, max_value)</code>

: Returns <code>~~val~~</code> such that it's between <code>~~min_val~~</code> and <code>~~max_val~~</code>.

: Returns <code>value</code> such that it is between <code>min_value</code> and <code>max_value</code>.

; <code>table_contains(tbl, value, compare_func)</code> *

: ~~Check~~ whether table ~~contains~~ <code>~~value~~</code>~~. Passing in~~ <code>~~compare_func~~</code> ~~is optional; if~~ <code>~~value~~</code> ~~is a table and~~ <code>~~tbl~~</code> ~~a table of tables, pass in a comparison function~~ <code>compare_func</code>, ~~which returns~~ <code>~~true~~</code> if <code>~~value~~</code> ~~and an element~~ in ~~<code>tbl</code> have the same value~~.~~{{clarify}}~~

: Checks whether table <code>tbl</code> contains <code>value</code> and returns <code>true</code> (if found) or <code>false</code> if not found. Passing <code>compare_func</code> is optional; By default, <code>value</code> is a numeric value or a string; to check for other values, such as ratios defined by [[Module: Rational]], a comparison function <code>compare_func</code> must be passed in.

; <code>index_of(array, value, compare_func)</code> *

: ~~Return~~ the first index with the given <code>value</code> (or nil if not found). Passing in <code>compare_func</code> is optional~~; if~~ <code>value</code> is a ~~table and <code>tbl</code>~~ a ~~table of tables~~, ~~pass in~~ a comparison function <code>compare_func</code>~~, which returns <code>true</code> if <code>value</code> and an element~~ in ~~<code>tbl</code> have the same value~~.~~{{clarify}}~~

: Returns the first index with the given <code>value</code> (or nil if not found). Passing <code>compare_func</code> is optional. By default, <code>value</code> is a numeric value or a string; to check for other values, such as ratios defined by [[Module:Rational]], a comparison function <code>compare_func</code> must be passed in.

; <code>value_provided(s)</code> *

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

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

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

: ~~Evaluate~~ <code>input</code> as a number, fraction notation supported; ~~on error, use~~ <code>def_value</code>.

: Evaluates <code>input</code> as a number, fraction notation supported but not other expressions; uses <code>def_value</code> on error.

; <code>log(x, b)</code>

: Returns the logarithm base <code>b</code> of <code>x</code>. Parameter <code>b</code> defaults to base 2 (octave) if it is omitted.

; <code>log2(x)</code>

: Returns the base-2 logarithm of <code>x</code>.

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

@@ Line 13: / Line 13: @@
 ; <code>_yesno(frame)</code>
-: Allows [[Module: Yesno]], which is not invokable directly, to be accessed by templates through [[Template: Yesno]].{{clarify}}
+: Wrapper function for [[Module: Yesno]], for use with templates. (Module: Yesno does not have a corresponding template.)
-; <code>_clamp(val, min_val, max_val)</code>
+; <code>_clamp(value, min_value, max_value)</code>
-: Returns <code>val</code> such that it's between <code>min_val</code> and <code>max_val</code>.
+: Returns <code>value</code> such that it is between <code>min_value</code> and <code>max_value</code>.
 ; <code>table_contains(tbl, value, compare_func)</code> *
-: Check whether table contains <code>value</code>. Passing in <code>compare_func</code> is optional; if <code>value</code> is a table and <code>tbl</code> a table of tables, pass in a comparison function <code>compare_func</code>, which returns <code>true</code> if <code>value</code> and an element in <code>tbl</code> have the same value.{{clarify}}
+: Checks whether table <code>tbl</code> contains <code>value</code> and returns <code>true</code> (if found) or <code>false</code> if not found. Passing <code>compare_func</code> is optional; By default, <code>value</code> is a numeric value or a string; to check for other values, such as ratios defined by [[Module: Rational]], a comparison function <code>compare_func</code> must be passed in.
 ; <code>index_of(array, value, compare_func)</code> *
-: Return the first index with the given <code>value</code> (or nil if not found). Passing in <code>compare_func</code> is optional; if <code>value</code> is a table and <code>tbl</code> a table of tables, pass in a comparison function <code>compare_func</code>, which returns <code>true</code> if <code>value</code> and an element in <code>tbl</code> have the same value.{{clarify}}
+: Returns the first index with the given <code>value</code> (or nil if not found). Passing <code>compare_func</code> is optional. By default, <code>value</code> is a numeric value or a string; to check for other values, such as ratios defined by [[Module:Rational]], a comparison function <code>compare_func</code> must be passed in.
 ; <code>value_provided(s)</code> *
-: Checks if <code>s</code> is a non-empty string.
+: Checks whether <code>s</code> is a non-empty string.
 ; <code>eval_num_arg(input, def_value)</code> *
-: Evaluate <code>input</code> as a number, fraction notation supported; on error, use <code>def_value</code>.
+: Evaluates <code>input</code> as a number, fraction notation supported but not other expressions; uses <code>def_value</code> on error.
 ; <code>log(x, b)</code>
 : Returns the logarithm base <code>b</code> of <code>x</code>. Parameter <code>b</code> defaults to base 2 (octave) if it is omitted.
+; <code>log2(x)</code>
+: Returns the base-2 logarithm of <code>x</code>.
 ; <code>gcd(a, b)</code>