Module:ET/doc: Difference between revisions

Latest revision as of 03:52, 31 October 2025

This module primarily serves as a library for other modules and has no corresponding template.

This module provides helper functions for equal-step tunings. To see introspection summary, see this module's main page.

@@ Line 1: / Line 1: @@
-{{Todo| documentation |inline=1}}
+{{documentation|{{dochead|header=library}}
-{{dochead|header=none}}
+This module provides helper functions for [[equal-step tuning]]s.
+{{module introspection
+| desc_new = Returns an array consisting of the components of an equal-step tuning.
+| desc_parse = Converts an equal tuning as a string into a Lua table.
+| desc_as_string = Returns the ET as a string.
+| desc_backslash_ratio = Converts steps to a proper ratio as a floating-point number.
+| desc_backslash_display = Displays an ET as steps\number-of-divisions.
+| desc_cents = Converts an interval of the ET into cents, {{c}}.
+| desc_hekts = Converts an interval of the ET into hekts, the relative cents of 13edt.
+| desc_approximate = Returns the floor, round, or ceiling of a particular ratio.
+| desc_tempers_out = Determines whether an ET tempers out a provided rational number.
+| desc_is_highly_composite = Determines whether an ET is highly composite.
+| desc_is_zeta = Determines if an ET holds any zeta records.
+| desc_why_zeta = Describes what specific properties an ET has if it is a zeta record ET.
+}}
+}}