Module:ET/doc: Difference between revisions

From Xenharmonic Wiki
Jump to navigation Jump to search
Ganaram inukshuk (talk | contribs)
transfer all function descriptions to module introspection; will need further formatting
Ganaram inukshuk (talk | contribs)
No edit summary
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
{{documentation|
{{documentation|{{dochead|header=library}}
{{dochead|header=none}}
This module provides helper functions for [[equal-step tuning]]s.
This module provides helper functions for [[equal-step tuning]]s.
{{module introspection
{{module introspection
| desc_new = Returns an array consisting of the components of an equal-step tuning.
| desc_new = Returns an array consisting of the components of an equal-step tuning.
Line 9: Line 7:
| desc_backslash_ratio = Converts steps to a proper ratio as a floating-point number.
| 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_backslash_display = Displays an ET as steps\number-of-divisions.
| desc_cents = Converts an interval of the ET into cents.
| 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_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_approximate = Returns the floor, round, or ceiling of a particular ratio.

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.