Fix simplify interval docs - #486
Open
danigb wants to merge 1 commit into
Open
Conversation
danigb
pushed a commit
that referenced
this pull request
Jul 18, 2026
Several README code examples printed outputs that don't match the
actual behavior of the published `tonal` package (v6.4.3), verified
by running each snippet against the installed npm package:
- packages/tonal/README.md: Note.midi("A4") documented as 60, actual
is 69; Note.freq("a4").freq called .freq on a number (undefined),
fixed to Note.freq("A4") // => 440.
- packages/pcset/README.md: Pcset.num(["c","d","e"]) and related
chroma/num round-trip examples documented 2192, actual is 2688
(consistent with the set's own chroma "101010000000" and with the
Pcset.get() example earlier in the same file); Pcset.intervals(
["c","d","e"]) documented ["1P","5P","7M"], actual is
["1P","2M","3M"].
- packages/scale-type/README.md: examples called the nonexistent
ScaleType.scale(...), corrected to the real API ScaleType.get(...).
packages/interval/README.md intentionally left untouched (maintainer
has an open docs PR #486 there). chord-type/README.md's Chord.detect
example was re-checked and found to already be correct as documented,
so it was left alone.
Co-authored-by: ymxlx <272607612+ymxlx@users.noreply.github.com>
Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #477