monome / teletype

monome eurorack module
GNU General Public License v2.0
202 stars 84 forks source link

N.CS lookup tables and documentation/help errors #289

Closed dstroud closed 9 months ago

dstroud commented 2 years ago

Please describe the bug.

  1. N.CS lookup values are in a different order depending on where we look:
N.CS N.CS Documentation N.CS Help N.S
Major Major Major Major
Natural Minor Natural Minor Natural Minor Natural Minor
Harmonic Minor Harmonic Minor Harmonic Minor Harmonic Minor
Melodic Minor Melodic Minor Melodic Minor Melodic Minor
Dorian Dorian Dorian Dorian
Phrygian Phrygian Phrygian Phrygian
Lydian Lydian Lydian Lydian
Locrian Myxolidian Locrian Myxolidian
Myxolidian Locrian Myxolidian Locrian
  1. The documentation has the wrong chord indices listed for the 'myxolidian' entry. Instead of {6, 0, 1, 1, 0, 2, 1} it should be {2, 1, 6, 0, 1, 1, 0}. The Locrian entry has the correct indices but the N.CS op does not work as expected due to issue # 1.

  2. AFAIK, the conventional spelling is 'mixolydian' rather than 'myxolidian'. This might be a good opportunity to update.

I propose a fix involving changing the order of the scales to be consistent with N.S and fixing the documentation to have the correct indices.

Please include the hash displayed at startup and the release of the software (e.g. "Teletype v2.0.1 5f838c9")

I've reproduced the issue on Teletype I2M Beta 2 but it appears present in the sources below.

What steps are required to reproduce the bug?

See the following: https://github.com/monome/teletype/blob/79db6011707cc5aafa2ba0ae6e0ebea38372af20/src/table.c#L134-L145 https://github.com/monome/teletype/blob/f6bc0249b139b2e25cd92acaeed7edadfa99d09e/docs/ops/maths.toml#L464-L473 https://github.com/monome/teletype/blob/f6bc0249b139b2e25cd92acaeed7edadfa99d09e/module/help_mode.c#L246-L264