Condense the 2.1 release notes and give them an intro - #336
Merged
Conversation
The section ran 4908 words over 26 entries, averaging 188 with a longest of 635. That is a specification, not release notes, and the substance was a second copy: usage.rst already carries the honorific peel, the comma and 间隔号 rules, the reach limits, the period rule and the vocabulary rationale. Nobody finds any of it in a changelog. Entries are now a summary and a link, 2137 words in the same 26 entries. Where content had no docs home it moved rather than being dropped: decomposed input gets a usage.rst section of its own, being a real concern for anyone reading names off macOS. Adds an intro paragraph in the shape 2.0.0 uses, saying what the release is for and how to turn it off. Em-dashes went from 75 to 0. At one every 65 words they had stopped marking anything. The NFD example in the new docs section is corrected from the one the release log implied: for an UNSPLIT decomposed name family holds the whole string, so comparing it to a one-syllable literal fails for the wrong reason. The spaced form splits normally and shows the encoding point properly, and both lines are verified.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #336 +/- ##
=======================================
Coverage 98.48% 98.48%
=======================================
Files 41 41
Lines 2845 2845
=======================================
Hits 2802 2802
Misses 43 43 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
#337 landed the segmenterless warning while this branch was open. Its release-log entry is rewritten in the shape the rest of the section now uses, and its usage.rst paragraph auto-merged ahead of the Decomposed text section, which is where it belongs.
The warning text landed mid-paragraph, between 'both halves are required' and the description of what ja_segmenter() does, so the factory description was split around it. The factory is one paragraph again and the warning is its own.
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
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.
Summary
The 2.1.0 section ran 4,908 words across 26 entries (188 average, longest 635). That is a specification rather than release notes, and it was largely a second copy of the docs:
usage.rstalready carries the glued/spaced honorific peel, the comma and 间隔号 rules, the reach limits, the period rule, and even the vocabulary rationale for 殿/양/博士.Now 2,137 words in the same 26 entries — a summary and a link each. Nothing is dropped; where content had no docs home it moved there instead.
Changes
An intro, in the shape 2.0.0 uses: what the release is for, that most of it is default-on and why, and the one-liner that restores 2.0's reading.
Entries condensed to a summary plus a cross-reference. Every
:ref:/:doc:target was verified to exist before use.Em-dashes: 75 → 0. At one every 65 words they had stopped marking anything.
A new
Decomposed textsection inusage.rst. This was the one topic with genuinely zero docs coverage (grepfor NFD/NFC/decomposed acrossdocs/returned nothing), and it is a real concern for anyone reading names off macOS. Two other uncovered topics, the 〆 shime mark and the Ukrainianй, stay release-log-only on purpose: they are "we now recognize X" facts rather than how-to material.One correction worth flagging
The release log implied this gotcha:
For an unsplit decomposed name that is False for the wrong reason:
familyholds the whole string김민준, so it differs in value, not just in encoding. The spaced form is the one that demonstrates the actual point, and the docs now use it:Both lines verified against the parser.
Verification
sphinx-build -b html— exit 0, 0 warningssphinx-build -b doctest— exit 0python -m doctest README.rst— exit 0uv run pytest -q— 3060 passedNo code changed.
🤖 Generated with Claude Code