Module:ET/doc: Difference between revisions

VisualWikitext

@@ Line 1: / Line 1: @@
-{{Todo| documentation |inline=1}}
+{{documentation|
+{{dochead|header=none}}{{lua|rational|sequence}}
+This module provides helper functions for [[equal-step tuning]]s.
-<includeonly><hr><small>Documentation transcluded from [[/doc]]</small> [[Category:Lua modules]]</includeonly>
+=== Functions ===
+; <code>new</code>
+: Returns an array consisting of the components of an equal-step tuning.
+; <code>parse</code>
+: Designed to convert strings in the format <code>[number of steps]ed[equave]</code> into an ET structure, and returns it via the <code>new</code> function. For example, <code>ET.parse("12edo")</code> returns an array containing <code>{12, 2, "edo"}</code>
+; <code>as_string</code>
+: Returns the string representation for an ET structure.
+; <code>backslash_ratio</code>
+: Converts steps to a proper ratio as a floating-point number.
+; <code>backslash_display</code>
+: Displays an ET structure in backslash form (<code>[steps]\[number of divisions]</code>).
+; <code>cents</code>
+: Converts the interval an ET structure represents to [[cent]]s.
+; <code>hekts</code>
+: Converts the interval an ET structure represents to [[hekt]]s ([[relative cent]] of [[13edt]]).
+; <code>approximate</code>
+: Returns the floor, round, or ceiling of a particular ratio.
+; <code>tempers_out</code>
+: Determines if an ET tempers out a provided rational number.
+; <code>is_highly_composite</code>
+: Determines if an ET is [[highly composite]].
+; <code>is_zeta</code>
+: Determines if an ET holds any [[The Riemann zeta function and tuning|zeta record]]s.
+; <code>why_zeta</code>
+: Describes what specific properties an ET has if it is a zeta record ET.
+}}