Module:Chord consistency/doc: Difference between revisions

(4 intermediate revisions by 2 users not shown)

Line 1:

{{documentation|{{dochead|header=~~none~~}}

{{documentation|{{dochead|header=library}}

This module provides some functions which enumerate [[consistent]] equal divisions relative to some chord.

=~~== Functions ===~~

{{module introspection

~~; <code>additively_consistent_int</code>~~

| desc_additively_consistent_int=A variant of additively_consistent from Module:Limits that must be supplied with octave-reduced intervals.

~~: Slightly differ version~~ of ~~<code>[[~~Module:Limits~~]].additively_consistent</code>. That function~~ must be supplied with octave-reduced intervals.

| desc_consistent_edos=Output list of consistent edos relative to given chord (Lua table of harmonics) up to 72edo. Different equaves, minimum consistency distance, maximum length of list are specifiable.

| desc_noinfobox_chord=Obsolete. Formerly used for Module:Infobox chord.}}

~~; <code>consistent_edos</code>~~

: Output list of consistent edos relative to given chord (Lua table of harmonics) up to 72edo. Different equaves, minimum consistency distance, maximum length of list are specifiable.

~~; <code>noinfobox_chord</code> (obsolete)~~

~~: A piece of code~~ for [[Module: Infobox chord]].

=== Format of edos list ===

Output of <code>consistent_edos</code> are links to individual edos with each trailing several asterisks. These indicate consistency distace ''d'' briefly, none as {{nowrap|1 ≤ ''d'' < 2}}; * as {{nowrap|2 ≤ ''d'' < 4}}; ** as {{nowrap|4 ≤ ''d'' < 8}}; …}}

@@ Line 1: / Line 1: @@
-{{documentation|{{dochead|header=none}}
+{{documentation|{{dochead|header=library}}
 This module provides some functions which enumerate [[consistent]] equal divisions relative to some chord.
-=== Functions ===
+{{module introspection
-; <code>additively_consistent_int</code>
+| desc_additively_consistent_int=A variant of additively_consistent from Module:Limits that must be supplied with octave-reduced intervals.
-: Slightly differ version of <code>[[Module:Limits]].additively_consistent</code>. That function must be supplied with octave-reduced intervals.
+| desc_consistent_edos=Output list of consistent edos relative to given chord (Lua table of harmonics) up to 72edo. Different equaves, minimum consistency distance, maximum length of list are specifiable.
+| desc_noinfobox_chord=Obsolete. Formerly used for Module:Infobox chord.}}
-; <code>consistent_edos</code>
-: Output list of consistent edos relative to given chord (Lua table of harmonics) up to 72edo. Different equaves, minimum consistency distance, maximum length of list are specifiable.
-; <code>noinfobox_chord</code> (obsolete)
-: A piece of code for [[Module: Infobox chord]].
 === Format of edos list ===
 Output of <code>consistent_edos</code> are links to individual edos with each trailing several asterisks. These indicate consistency distace ''d'' briefly, none as {{nowrap|1 ≤ ''d'' < 2}}; * as {{nowrap|2 ≤ ''d'' < 4}}; ** as {{nowrap|4 ≤ ''d'' < 8}}; …}}