Module:Utils/doc - Revision history

FloraC: Revert for readability (see talk)

2025-12-12T10:37:05Z

Revert for readability (see talk)

← Older revision		Revision as of 10:37, 12 December 2025
Line 6:		Line 6:
	For pairs of functions with names that differ by a single leading underscore (for example, <code>gcd</code> and <code>_gcd</code>), the function ''with'' an underscore is meant to be called by other modules, and the function ''without'' an underscore can be used with <code>#invoke</code>.		For pairs of functions with names that differ by a single leading underscore (for example, <code>gcd</code> and <code>_gcd</code>), the function ''with'' an underscore is meant to be called by other modules, and the function ''without'' an underscore can be used with <code>#invoke</code>.

	{{Module introspection		{{Module introspection}}
	~~\| desc_trim~~ = Removes leading and trailing whitespaces (but not interior ones) from a string.
	~~\| desc__yesno =~~ Wrapper function for [[Module:Yesno]], for use with templates. (Module:Yesno does not have a corresponding template.)		=== Functions ===
	~~\| desc__clamp =~~ Returns <code>~~val~~</code> such that it is between <code>~~min_val~~</code> and <code>~~max_val~~</code>.		; <code>trim(s)</code>
	~~\| desc_table_contains =~~ 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.		: Removes leading and trailing whitespaces (but not interior ones) from a string.
	~~\| desc_index_of =~~ 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.
	~~\| desc_value_provided =~~ Checks whether <code>s</code> is a non-empty string.		; <code>_yesno(frame)</code>
	~~\| desc_eval_num_arg =~~ Evaluates <code>input</code> as a number, fraction notation supported but not other expressions; uses <code>def_value</code> on error.		: Wrapper function for [[Module: Yesno]], for use with templates. (Module: Yesno does not have a corresponding template.)
	~~\| desc_log =~~ Returns the logarithm base <code>b</code> of <code>x</code>. Parameter <code>b</code> defaults to base 2 (octave) if it is omitted.
	~~\| desc_gcd =~~ Returns the greatest common divisor of <code>a</code> and <code>b</code>.		; <code>_clamp(value, min_value, max_value)</code>
	~~\| desc_round_dec =~~ Returns <code>x</code> rounded to a precision of <code>places</code> decimal places. Parameter <code>places</code> defaults to 0 if it is omitted.		: Returns <code>value</code> such that it is between <code>min_value</code> and <code>max_value</code>.
	~~\| desc_round =~~ Returns <code>x</code> rounded to a precision of <code>prec</code> significant figures. Parameter <code>prec</code> defaults to 6 if it is omitted.
	~~\| desc_is_prime =~~ Returns <code>true</code> if the given integer <code>n</code> is a prime number.		; <code>table_contains(tbl, value, compare_func)</code> *
	~~\| desc_prime_factorization =~~ Returns the prime factorization of the given integer <code>n</code> using the exponential form (in wikitext).		: 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.
	~~\| desc_prime_factorization_raw =~~ Returns a table encoding the prime factorization of <code>n</code>.
	~~\| desc_signum =~~ Returns 1 for positive numbers, −1 for negative ones, and 0 for zero and non-integer inputs.		; <code>index_of(array, value, compare_func)</code> *
	~~\| desc_next_young_diagram =~~ 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 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.
	~~\| desc_log2 = Returns the base-2 logarithm of <code>x</code>.~~
	~~\| desc__log = Lua-only implementation of~~ <~~code~~>~~log~~</~~code~~>.		; <code>value_provided(s)</code> *
	~~\| desc__gcd = Lua-~~only ~~implementation of~~ <code>~~gcd~~<~~/code~~>.		: Checks whether <code>s</code> is a non-empty string.
	~~\| desc__round_dec = Lua-only implementation of <code>round_dec~~</~~code~~>.
	~~\| desc__round = Lua-only implementation of <code>round~~</code>.		; <code>eval_num_arg(input, def_value)</code> *
	~~\| desc__prime_factorization = Lua-only implementation of <code>prime_factorization</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>
			: Returns the greatest common divisor of <code>a</code> and <code>b</code>.

			; <code>round_dec(x, places)</code>
			: Returns <code>x</code> rounded to a precision of <code>places</code> decimal places. Parameter <code>places</code> defaults to 0 if it is omitted.

			; <code>round(x, prec)</code>
			: Returns <code>x</code> rounded to a precision of <code>prec</code> significant figures. Parameter <code>prec</code> defaults to 6 if it is omitted.

			; <code>is_prime(n)</code>*
			: Returns <code>true</code> if the given integer <code>n</code> is a prime number.

			; <code>prime_factorization(n)</code>
			: Returns the prime factorization of the given integer <code>n</code> using the exponential form (in wikitext).

			; <code>prime_factorization_raw(n)</code> *
			: Returns a table encoding the prime factorization of <code>n</code>.

			; <code>signum(x)</code> *
			: Returns 1 for positive numbers, −1 for negative ones, and 0 for zero and non-integer inputs.

			; <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.

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

	}}		}}

Ganaram inukshuk at 04:28, 25 November 2025

2025-11-25T04:28:35Z

← Older revision		Revision as of 04:28, 25 November 2025
Line 29:		Line 29:
	\| desc__round = Lua-only implementation of <code>round</code>.		\| desc__round = Lua-only implementation of <code>round</code>.
	\| desc__prime_factorization = Lua-only implementation of <code>prime_factorization</code>.		\| desc__prime_factorization = Lua-only implementation of <code>prime_factorization</code>.
			}}
	}}		}}

Ganaram inukshuk at 04:27, 25 November 2025

2025-11-25T04:27:59Z

← Older revision		Revision as of 04:27, 25 November 2025
Line 22:		Line 22:
	\| desc_prime_factorization_raw = Returns a table encoding the prime factorization of <code>n</code>.		\| desc_prime_factorization_raw = Returns a table encoding the prime factorization of <code>n</code>.
	\| desc_signum = Returns 1 for positive numbers, −1 for negative ones, and 0 for zero and non-integer inputs.		\| desc_signum = Returns 1 for positive numbers, −1 for negative ones, and 0 for zero and non-integer inputs.
	\| desc_next_young_diagram = 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.}}		\| desc_next_young_diagram = 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.
	\| desc_log2 = Returns the base-2 logarithm of <code>x</code>.		\| desc_log2 = Returns the base-2 logarithm of <code>x</code>.
	\| desc__log = Lua-only implementation of <code>log</code>.		\| desc__log = Lua-only implementation of <code>log</code>.

Ganaram inukshuk: add descriptions for other functions

2025-11-25T04:26:10Z

add descriptions for other functions

← Older revision		Revision as of 04:26, 25 November 2025
Line 9:		Line 9:
	\| desc_trim = Removes leading and trailing whitespaces (but not interior ones) from a string.		\| desc_trim = Removes leading and trailing whitespaces (but not interior ones) from a string.
	\| desc__yesno = Wrapper function for [[Module:Yesno]], for use with templates. (Module:Yesno does not have a corresponding template.)		\| desc__yesno = Wrapper function for [[Module:Yesno]], for use with templates. (Module:Yesno does not have a corresponding template.)
			\| desc__clamp = Returns <code>val</code> such that it is between <code>min_val</code> and <code>max_val</code>.
	\| desc_table_contains = 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.		\| desc_table_contains = 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.
	\| desc_index_of = 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.		\| desc_index_of = 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.
Line 14:		Line 15:
	\| desc_eval_num_arg = Evaluates <code>input</code> as a number, fraction notation supported but not other expressions; uses <code>def_value</code> on error.		\| desc_eval_num_arg = Evaluates <code>input</code> as a number, fraction notation supported but not other expressions; uses <code>def_value</code> on error.
	\| desc_log = Returns the logarithm base <code>b</code> of <code>x</code>. Parameter <code>b</code> defaults to base 2 (octave) if it is omitted.		\| desc_log = Returns the logarithm base <code>b</code> of <code>x</code>. Parameter <code>b</code> defaults to base 2 (octave) if it is omitted.
	\| desc_gcd = Returns the greatest common divisor of <code>a</code> and <code>b</code>.		\| desc_gcd = Returns the greatest common divisor of <code>a</code> and <code>b</code>.
	\| desc_round_dec = Returns <code>x</code> rounded to a precision of <code>places</code> decimal places. Parameter <code>places</code> defaults to 0 if it is omitted.		\| desc_round_dec = Returns <code>x</code> rounded to a precision of <code>places</code> decimal places. Parameter <code>places</code> defaults to 0 if it is omitted.
	\| desc_round = Returns <code>x</code> rounded to a precision of <code>prec</code> significant figures. Parameter <code>prec</code> defaults to 6 if it is omitted.		\| desc_round = Returns <code>x</code> rounded to a precision of <code>prec</code> significant figures. Parameter <code>prec</code> defaults to 6 if it is omitted.
Line 22:		Line 23:
	\| desc_signum = Returns 1 for positive numbers, −1 for negative ones, and 0 for zero and non-integer inputs.		\| desc_signum = Returns 1 for positive numbers, −1 for negative ones, and 0 for zero and non-integer inputs.
	\| desc_next_young_diagram = 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.}}		\| desc_next_young_diagram = 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.}}
			\| desc_log2 = Returns the base-2 logarithm of <code>x</code>.
			\| desc__log = Lua-only implementation of <code>log</code>.
			\| desc__gcd = Lua-only implementation of <code>gcd</code>.
			\| desc__round_dec = Lua-only implementation of <code>round_dec</code>.
			\| desc__round = Lua-only implementation of <code>round</code>.
			\| desc__prime_factorization = Lua-only implementation of <code>prime_factorization</code>.
	}}		}}

Ganaram inukshuk: clarify; transfer all function descriptions to module introspection

2025-11-25T04:19:48Z

clarify; transfer all function descriptions to module introspection

← Older revision		Revision as of 04:19, 25 November 2025
Line 8:		Line 8:
	{{Module introspection		{{Module introspection
	\| desc_trim = Removes leading and trailing whitespaces (but not interior ones) from a string.		\| desc_trim = Removes leading and trailing whitespaces (but not interior ones) from a string.
	\| desc__yesno = Wrapper function for [[Module:Yesno]], for use with templates. }}		\| desc__yesno = Wrapper function for [[Module:Yesno]], for use with templates. (Module:Yesno does not have a corresponding template.)
			\| desc_table_contains = 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.
	~~=== Functions ===~~		\| desc_index_of = 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.
			\| desc_value_provided = Checks whether <code>s</code> is a non-empty string.
			\| desc_eval_num_arg = Evaluates <code>input</code> as a number, fraction notation supported but not other expressions; uses <code>def_value</code> on error.
	~~; <code>_clamp~~(~~val, min_val, max_val~~)~~</code>~~		\| desc_log = Returns the logarithm base <code>b</code> of <code>x</code>. Parameter <code>b</code> defaults to base 2 (octave) if it is omitted.
	~~: Returns~~ <code>~~val~~</code> ~~such that it's between~~ <code>~~min_val~~</code> and <code>~~max_val~~</code>.		\| desc_gcd = Returns the greatest common divisor of <code>a</code> and <code>b</code>.
			\| desc_round_dec = Returns <code>x</code> rounded to a precision of <code>places</code> decimal places. Parameter <code>places</code> defaults to 0 if it is omitted.
	~~; <code>table_contains~~(~~tbl, value, compare_func~~)</code> *		\| desc_round = Returns <code>x</code> rounded to a precision of <code>prec</code> significant figures. Parameter <code>prec</code> defaults to 6 if it is omitted.
	~~: Checks whether table~~ <code>~~tbl</code> 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}}~~		\| desc_is_prime = Returns <code>true</code> if the given integer <code>n</code> is a prime number.
			\| desc_prime_factorization = Returns the prime factorization of the given integer <code>n</code> using the exponential form (in wikitext).
	; <code>index_of(array, value, compare_func)</code> *		\| desc_prime_factorization_raw = Returns a table encoding the prime factorization of <code>n</code>.
	: Returns 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}}~~		\| desc_signum = Returns 1 for positive numbers, −1 for negative ones, and 0 for zero and non-integer inputs.
			\| desc_next_young_diagram = 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.}}
	; <code>value_provided(s)</code> *
	: Checks if <code>s</code> is a non-empty string.

	; <code>eval_num_arg(input, 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>gcd(a, b)</code>~~
	: Returns the greatest common divisor of <code>a</code> and <code>b</code>.

	~~; <code>round_dec(x, places)</code>~~
	: Returns <code>x</code> rounded to a precision of <code>places</code> decimal places. Parameter <code>places</code> defaults to 0 if it is omitted.

	~~; <code>round(x, prec)</code>~~
	: Returns <code>x</code> rounded to a precision of <code>prec</code> significant figures. Parameter <code>prec</code> defaults to 6 if it is omitted.

	; <code>is_prime(n)</code>*
	: Returns <code>true</code> if the given integer <code>n</code> is a prime number.

	~~; <code>prime_factorization(n)</code>~~
	: Returns the prime factorization of the given integer <code>n</code> using the exponential form (in wikitext).

	; <code>prime_factorization_raw(n)</code> *
	: Returns a table encoding the prime factorization of <code>n</code>.

	; <code>signum(x)</code> *
	: Returns 1 for positive numbers, −1 for negative ones, and 0 for zero and non-integer inputs.

	~~; <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.

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

	}}		}}

Ganaram inukshuk at 04:10, 25 November 2025

2025-11-25T04:10:15Z

← Older revision		Revision as of 04:10, 25 November 2025
Line 8:		Line 8:
	{{Module introspection		{{Module introspection
	\| desc_trim = Removes leading and trailing whitespaces (but not interior ones) from a string.		\| desc_trim = Removes leading and trailing whitespaces (but not interior ones) from a string.
	\| ~~desc_yesno~~ = Wrapper function for [[Module:Yesno]], for use with templates. }}		\| desc__yesno = Wrapper function for [[Module:Yesno]], for use with templates. }}

	=== Functions ===		=== Functions ===

Ganaram inukshuk: Partially transfer function descriptions to module introspection

2025-11-25T04:09:35Z

Partially transfer function descriptions to module introspection

← Older revision		Revision as of 04:09, 25 November 2025
Line 6:		Line 6:
	For pairs of functions with names that differ by a single leading underscore (for example, <code>gcd</code> and <code>_gcd</code>), the function ''with'' an underscore is meant to be called by other modules, and the function ''without'' an underscore can be used with <code>#invoke</code>.		For pairs of functions with names that differ by a single leading underscore (for example, <code>gcd</code> and <code>_gcd</code>), the function ''with'' an underscore is meant to be called by other modules, and the function ''without'' an underscore can be used with <code>#invoke</code>.

	{{Module introspection}}		{{Module introspection
			\| desc_trim = Removes leading and trailing whitespaces (but not interior ones) from a string.
			\| desc_yesno = Wrapper function for [[Module:Yesno]], for use with templates. }}

	=== Functions ===		=== Functions ===
	~~; <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]].{{clarify}}~~

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

FloraC: Clarify +1 and consistency

2025-11-24T15:21:39Z

Clarify +1 and consistency

← Older revision		Revision as of 15:21, 24 November 2025
Line 19:		Line 19:

	; <code>table_contains(tbl, value, compare_func)</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>. 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}}

	; <code>index_of(array, value, compare_func)</code> *		; <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 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}}

	; <code>value_provided(s)</code> *		; <code>value_provided(s)</code> *
Line 28:		Line 28:

	; <code>eval_num_arg(input, def_value)</code> *		; <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>		; <code>log(x, b)</code>

FloraC: Clarify on eval_num_arg

2025-11-24T15:19:17Z

Clarify on eval_num_arg

← Older revision		Revision as of 15:19, 24 November 2025
Line 27:		Line 27:
	: Checks if <code>s</code> is a non-empty string.		: Checks if <code>s</code> is a non-empty string.

	; <code>eval_num_arg(input,~~ ~~def_value)</code> *		; <code>eval_num_arg(input, def_value)</code> *
	: ~~Checks if~~ <code>input</code> is a number; on error, use <code>def_value</code>.		: Evaluate <code>input</code> as a number, fraction notation supported; on error, use <code>def_value</code>.

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

FloraC: Add back function descriptions. Request clarification

2025-11-24T13:26:58Z

Add back function descriptions. Request clarification

@@ Line 1: / Line 1: @@
-{{documentation|{{dochead|header=library}}
+{{Documentation|{{dochead|header=library}}
 This module provides several mathematical functions which are likely to be used frequently on the Xenharmonic Wiki.
@@ Line 5: / Line 5: @@
 For pairs of functions with names that differ by a single leading underscore (for example, <code>gcd</code> and <code>_gcd</code>), the function ''with'' an underscore is meant to be called by other modules, and the function ''without'' an underscore can be used with <code>#invoke</code>.
-{{module introspection}}
-{{todo|inline=1|expand|comment=add back function descriptions}}
+{{Module introspection}}
 }}