Skip to content

fix: correct miscelaneousFields typo in EncodingData - #391

Merged
webern merged 2 commits into
webern:mainfrom
rpatters1:api-fix-miscellaneous-typo
Aug 7, 2026
Merged

fix: correct miscelaneousFields typo in EncodingData#391
webern merged 2 commits into
webern:mainfrom
rpatters1:api-fix-miscellaneous-typo

Conversation

@rpatters1

@rpatters1 rpatters1 commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

Human Summary

  • Correct misspelling of field miscellaneousFields.
  • Correct other typos found throughout repo.

Summary

Two commits. The first is the field rename; the second sweeps up the other misspellings a dictionary pass over the identifiers turned up.

EncodingData::miscelaneousFields -> miscellaneousFields

Missing an l. The class the vector holds, MiscellaneousField, was already spelled correctly, as are core::Miscellaneous, core::MiscellaneousField, and the <miscellaneous-field> element itself, so this member was the lone outlier. Eight occurrences in five files: the declaration and its MXAPI_EQUALS_MEMBER line, the reader and writer, and two test score-data builders.

Breaking: the member is public mx::api, so callers using the old spelling must rename. No compatibility alias is left behind, matching how the ScoreData layout -> defaults rename was handled in v0.5.0.

Other misspellings

Checking whether any sibling had the same problem meant spell-checking every identifier in the tree. It was the only misspelled public field name, but four other things turned up. None is breaking -- they are private mx::impl names and comment text.

TechnicalFunctions had the same word misspelled two different ways, while the class itself was spelled correctly: parseTechicalMark and its techicalChoice parameter dropped the n, and the constructor parameter inTechincalChoiceSet and member myTechincalChoiceSet transposed it. MeasureReader::isUserRequestedVoiceNumberConsistentAccrossAllVoices had a doubled c.

Comment fixes in public headers: alyways, convient, otherwords, and Clarient in the TransposeData doc table, which is rendered documentation. The table is column-aligned and Clarinet is the same width, so the alignment holds.

SoundID.h is deliberately untouched. brass.sackbutt and strings.violono.piccolo look wrong but mirror the MusicXML standard sound-id strings and have to match the wire format.

The rename in TechnicalFunctions.cpp lengthened a signature by one character, so make fmt reindented that function's continuation lines. That is the only non-rename change in the second commit.

Testing

  • Full api suite passes (5961 assertions in 535 test cases)
  • make api-roundtrip passes (364 of 364 pinned)
  • make core-roundtrip-test passes (839 test cases)
  • make fmt-check clean on touched files
  • grep for every corrected spelling returns nothing outside core/generated

Renames only -- no behaviour change, so no new tests. The existing ApiK016aMisc and ApiLy43e suites already exercise the renamed EncodingData member on both the read and write paths, and the technical-mark and voice-number paths are covered by the api suite.

EncodingData::miscelaneousFields was missing an 'l'. The class it holds,
MiscellaneousField, and every core-side name were already spelled correctly, so
the member was the lone outlier.

Breaking: the member is public mx::api. Callers using the old spelling must
rename. No alias is left behind, matching the ScoreData layout -> defaults
rename in v0.5.0.
Follows the miscellaneousFields rename with the other misspellings a
dictionary pass over the identifiers turned up. All are private mx::impl
names or comment text, so nothing here is breaking.

TechnicalFunctions had the same word misspelled two different ways while the
class itself was spelled correctly: parseTechicalMark and its techicalChoice
parameter dropped the 'n', and the constructor parameter inTechincalChoiceSet
and member myTechincalChoiceSet transposed it. MeasureReader's
isUserRequestedVoiceNumberConsistentAccrossAllVoices had a doubled 'c'.

Comment fixes in public headers: alyways, convient, otherwords, and Clarient
in the TransposeData doc table.

SoundID.h is deliberately untouched. brass.sackbutt and
strings.violono.piccolo mirror the MusicXML standard sound-id strings and
must match the wire format.

@webern webern left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Those were the good old days of slamming stuff out by hand!

@webern
webern merged commit 7c3062c into webern:main Aug 7, 2026
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants