Module:ET/doc: Difference between revisions
ArrowHead294 (talk | contribs) m Fill in documentation |
ArrowHead294 (talk | contribs) mNo edit summary |
||
| (4 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{documentation|{{dochead|header=none}} | {{documentation| | ||
{{dochead|header=none}}{{lua|rational|sequence}} | |||
This module provides helper functions for [[equal-step tuning]]s. | This module provides helper functions for [[equal-step tuning]]s. | ||
| Line 7: | Line 8: | ||
; <code>parse</code> | ; <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> | ; <code>as_string</code> | ||
| Line 21: | Line 22: | ||
: Converts the interval an ET structure represents to [[cent]]s. | : Converts the interval an ET structure represents to [[cent]]s. | ||
; <code> | ; <code>hekts</code> | ||
: Converts the interval an ET structure represents to [[hekt]]s ( | : Converts the interval an ET structure represents to [[hekt]]s ([[relative cent]] of [[13edt]]). | ||
; <code>approximate</code> | ; <code>approximate</code> | ||