Skip to content

Release sweep for 3.0: stale prose since the first sweep - #1173

Merged
derek73 merged 4 commits into
masterfrom
docs/release-sweep-3-0
Nov 8, 2026
Merged

derek73 merged 4 commits into
masterfrom
docs/release-sweep-3-0

Conversation

@derek73

@derek73 derek73 commented Nov 8, 2026

Copy link
Copy Markdown
Owner

The release checklist's stale-prose sweep (root AGENTS.md, Release checklist, step 0) over the 46 commits since the first sweep (#1079, 2d91f6b), run after the simplify passes (#1153, #1154, #1157, #1158). Docs and comments only: tools/differential/snapshot.jsonl is byte-identical to master.

Sites walked

Checklist site What was checked What changed
docs/*.rst usage.rst examples and API surface, customize.rst's Policy table and switch sections, locales.rst's pack table and VI section, concepts.rst; every example re-run usage.rst's command-line section documents --lone-name-word (#1114 listed it in --help only). customize.rst's two_family_names row says the first two under a family-first order, and its lone-word section names a family comma (both directions) and the kana that settle order. concepts.rst says how a one-word name is placed (a title or a script that settles order deciding first). locales.rst: under vi, CHI after a comma stays a suffix only in a mixed-case name (NGUYEN VAN ANH, CHI reads given CHI).
migrate.rst "Changed in 3.0" each release-log bullet added since 2d91f6b naming 1.4.0, run on the tree and on the 1.4.0 wheel (PYTHONSAFEPATH=1, outside the worktree) Ten shapes added with doctests: John Smith y V, NFD 이서연·김민준, Priv.-Doz., PhD/NP-C and MA/PhD, (Ma, PhD) and (Msc.Ed), 'Smitty' Jones Jr., Mohd., the five titles no name bears, Mary Smith, Mst. The pickle paragraph's "23 credentials and 13 case masks" was a standing count, now stale (a 2.8.0 Lexicon.default() pickle lacks 108 credentials and 72 masks, measured 2026-11-07), so the number is dropped; no test held it.
README.rst python -m doctest README.rst; readme_renderer; announcement read checked, nothing stale
autodoc docstrings _policy.py, _types.py, _parser.py, _lexicon.py, _locale.py, locales/*.py, __main__.py locales/pt.py names the default-off reading it turns on (piedade, #1118/#1122). locales/vi.py: DEVIATES declares a name holding a letter or a digit; the CHI clause as above. Policy.name_order points at lone_name_word.
user-facing messages every raise/warn offering code, run The --two-family-names help said "the last two"; the first two under a family-first --order. Nothing pins the help text.
_pipeline/*.py Reads: lines the checklist's grep, per module, against each Reads: line All match. classify's "Tags emitted" list, beside its Reads:, lacked vocab:joined-title (#1104) and vocab:title-case-name (#1039); added.
tests/v2/cases.py notes notes on rows the late PRs moved, re-run a_suffixed_family_before_a_comma_suffix_reads_positionally said Smith Jr. alone reads as it does before the comma; alone it reads given and reports given-or-family (O5).
docs/design/ rules, decisions, mechanisms.md read every file the late PRs touched and the rules whose territory they reached (O5's lone word across the whole tree) rules/O4 (positional assignment and declared order): its family-first bullet read a one-word name as the family; a new bullet hands it to O5 (lone name words), so O4's budget is re-recorded, +11 words, a pointer reading no new signal (axis 12). rules/S3 (credentials written in joined chunks): John Smith MA no longer keeps the family (S6 reads it); now John Smith Ma. decisions/vocabulary-model's 2026-11-05 #1108 entry corrected in place, with a dated note: the capitals shape takes CHI after a comma in the part right after the comma only where the name's case contrasts and two name words stand before it (past a second comma it is a suffix in any case), and only because the pack removes its credential reading.
every AGENTS.md (six, read whole) about 200 named helpers, tests and tool flags grepped; about 150 behavior claims run Root: the classify Reads: count ("twenty, 17") replaced by a count-free statement; _assemble's Reads: reason; --locale vi now that locales.VI exists; the snapshot records each report's alternative; the command block mentions the CLI flags. _pipeline/AGENTS.md: the two-way-fork example (John Smith MA / Jack MA no longer report it) is now John Smith V / John V. vocab/AGENTS.md: PARTICLES ∩ TITLES includes the ranks (#709). docs/, docs/design/ and nameparser/AGENTS.md: checked, nothing stale.
release log bullets added since 2d91f6b, examples run The lone-word bullet's "a Han or Hangul script still decides first" names a family comma and the kana that settle order too. No other bullet is wrong about behavior; the release notes and the "under development" lead are left for the release step.

Also folded in from the simplify passes: a ("MD.Filho", False) row in period_joined_credential's table. It fails with S11's clause removed, but so does the existing Msc.Filho row by the same path, so the clause was already guarded; the row stays as the example the code comment names. M.Filho, the row with no settling chunk, passes with the clause removed, and is the one S11 row that is no control.

Follow-up, not done here

rules/O5 glosses a family comma as "a comma with a name segment after it", but Anh, Jr. and Anh, PhD, which have none, are decided (family Anh) and silent too. The gloss or an Except bullet citing C8 would make O5 say what the parser does. A rule change, so not part of a prose sweep.

Reviews

  • Round 1 on 6935ec5: pr-review-toolkit:comment-analyzer (precision: concepts.rst's script exception, the family comma missing from the "decides first" lists, pt.py's count), design-docs-reviewer (the decisions correction needed a kind-2 note and C6's condition; O4's pointer belonged in its own bullet), code-reviewer on the test row (MD.Filho duplicates Msc.Filho; customize.rst's two_family_names row). All fixed in d37e7bd.
  • Round 2 on d37e7bd: design-docs-reviewer and comment-analyzer both found that the first fix widened the C6 claim, dropping the three-letter limit and C4's count (Nguyen Van Anh, DO, Anh, CHI contradicted it). Restored, with clarity fixes, in the third commit.
  • Round 3 on 28193a9: design-docs-reviewer on the C6 sentence, with a grid of heads × words under the pack and the default. The limits hold in the part right after the comma but not past a second comma, where C2 makes CHI a suffix in any case (NGUYEN, VAN ANH, CHI). concepts.rst's lone-word sentence also omitted a title (Mr. Johnson). Both fixed in the fourth commit, whose examples were verified by running them, with no fourth review round.

Checks

uv run pytest (40,186 passed, 6 skipped, 5 xfailed), uv run pytest -n0 -m serial (60 passed), sphinx-build -b doctest (0 failures), -b html, uv run mypy, uv run ruff check, python -m doctest README.rst, readme_renderer.

🤖 Generated with Claude Code

derek73 and others added 4 commits November 7, 2026 23:19
The release checklist's stale-prose sweep, over the commits since
2d91f6b (#1079): migrate.rst's "Changed in 3.0" list gains the ten
late shapes 1.4.0 read differently, each with a doctest; the CLI
section documents --lone-name-word; the lone-word, VI CHI, PT piedade,
two_family_names help and classify tag-list prose is brought in line
with the tree; rules/O4 and S3, one decisions entry, and four
AGENTS.md files are corrected. Adds the MD.Filho row to
period_joined_credential's table and fixes vi.py's DEVIATES wording.
O4's budget is re-recorded for one clause pointing at O5.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Dates the vocabulary-model correction and states C6's condition; gives
O4's one-word pointer its own bullet; scopes concepts.rst's lone-word
sentence to name_order; adds a family comma to the lists of what
decides a lone word first; dates pt.py's count of default-off readings;
aligns customize.rst's two_family_names row with the CLI help; says the
MD.Filho row shares Msc.Filho's path.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Restores the three-letter and C4 limits the first fix dropped from the
vocabulary-model correction, with the one-name-word contrast; names the
script exception in concepts.rst's lone-word sentence; gives
customize.rst's family comma its two directions; untangles pt.py's
opening sentence; names the code comment the MD.Filho row copies.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Scopes the vocabulary-model CHI clause to the part right after the
first comma, adding that past a second comma CHI stays a suffix in any
case (rules/C2); concepts.rst's lone-word sentence names a title.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@derek73 derek73 added this to the 3.0 milestone Nov 8, 2026
@derek73 derek73 added the docs Documentation fixes and updates label Nov 8, 2026
@derek73 derek73 self-assigned this Nov 8, 2026
@derek73
derek73 merged commit 0747396 into master Nov 8, 2026
13 checks passed
@derek73
derek73 deleted the docs/release-sweep-3-0 branch November 8, 2026 09:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation fixes and updates

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant