Give Boundaries subheadings, shorter paragraphs, and examples - #338
Merged
Conversation
The section ran 1444 words in 11 paragraphs with no subheadings, and one paragraph was 410 words on its own. It carried good rationale that was hard to scan and impossible to link to. Eight subheadings now, and the 410-word paragraph is three of them: honorifics coming off first, what commas and dots do and do not stop, and the credentials-run rule. The longest prose paragraph is 112 words. Six doctest blocks where the prose previously asserted behavior without showing it. The reach limit and the credentials rule get examples in particular, being the two rules hardest to believe unseen. All of them run under the default configuration: the Korean and Chinese honorific cases go through vocabulary rather than a segmenter, so nothing here needs namedivider, which is installed only in the ja-extra CI job. The segmenter contrast stays prose for that reason. Em-dashes went from 22 to 0.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #338 +/- ##
=======================================
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:
|
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
Boundariessubsection ofusage.rstran 1,444 words in 11 paragraphs with no subheadings, one of them 410 words on its own. The rationale in it is good, but it was hard to scan and impossible to link to.Now 8 subheadings, longest prose paragraph 112 words, and 6 doctest blocks where the prose previously asserted behavior without showing it.
Structure
The 410-word paragraph became three of those: honorifics coming off first, what commas and dots do and don't stop, and the credentials-run rule. The orphaned 35-word command-line paragraph folded into the last section.
Examples
Six doctest blocks, all verified. The two most valuable pin rules that are hard to believe without seeing:
All of them run under the default configuration. The Korean and Chinese honorific cases go through vocabulary rather than a segmenter, so nothing here needs
namedivider, which is installed only in theja-extraCI job and not in the main matrix. The segmenter contrast (佐藤 氏vs bare佐藤under the JA pack) stays prose for exactly that reason, matching how the existing JA examples are written ascode-blockrather thandoctest.Other
Em-dashes 22 → 0. Word count 1,444 → 1,504; the small growth is the subheadings and the example blocks, with prose slightly tightened where paragraphs were split.
Content is Derek's, restructured rather than rewritten.
Verification
sphinx-build -b doctest— exit 0, all 6 new blocks passsphinx-build -b html— exit 0, 0 warnings (the internalWhen the parser had to guess_ reference still resolves)python -m doctest README.rst— exit 0uv run pytest -q— 3064 passedNo code changed.
🤖 Generated with Claude Code