Repository navigation
Commit e189822
Trim the 2.4.0 release notes to index bullets and link issues (#646)
* docs(release): cut the 2.4.0 notes to index bullets and link issues
Each 2.4.0 bullet is now a bold lead, one before/after example and
:issue: links; the mechanism, boundary cases and measurements stay in
the issues and docs/design/decisions.md. Bullets a user sees as one
change are merged. 10,765 words and 45 bullets become 1,491 and 32.
Add sphinx.ext.extlinks with an :issue: role and convert the older
entries' #N references (223 of them; the 21 inside bold leads stay
plain, since RST markup does not nest). Fix a `()#147)` typo and a
bold lead that rendered raw backticks. AGENTS.md's release-log
instructions describe the new bullet shape.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
* docs(release): add the 2.4.0 summary and use realistic examples
The 2.4.0 entry opens with a summary and six highlights. Examples
that showed a cost (PhD Jones) or used placeholders (X.Y.Z., x.y.z.)
are replaced by real credentials (LEED AP, N.C.C., r.d.n.) and names
(Jane Smith, PhD MA; Eric H. Holder Jr. Attorney General); MA vs Ma
is shown on one name. Every example was checked against the 2.3.0
wheel and the tree.
The performance bullet's "make parsing faster" lead is dropped:
measured on py3.11, ordinary names parse in the same time as 2.3.0
(about 68 us/name for parse() over 866 corpus names); the 25% fewer
calls per parse do not show on the clock. Sentences ending in an
example that ends in a period no longer render a double period.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
* docs(release): link 2.4.0 bullets to the user-docs sections
Fourteen 2.4.0 bullets now end with "See <section>." pointing at the
usage or customize section that documents the behavior or its knob
(CapsSuffixes.OFF lives under customize's "All-caps words"). Six
headings gain labels for this: trailing-titles, parser-guesses and
credentials-also-surnames in usage.rst; connectives-also-initials,
dotted-credentials and all-caps-credentials in customize.rst.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
* docs(customize): show a user's own mask outranking a particle's lowercase
The 2.4.0 release note says a caller's capitalization_exceptions entry
now outranks the lowercase case repair gives a particle, but the docs
witnessed the rule only with the shipped Irish masks. Add a doctest
with a ("van", "Van") entry: Martin Van Buren keeps his capital, and
Ludwig Van Beethoven shows the cost, since a mask applies wherever its
word stands.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
* docs(release): link the Irish-particle bullet to the case-exceptions section
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
---------
Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>1 parent 6dae824 commit e189822
5 files changed
Lines changed: 287 additions & 263 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
73 | 73 | | |
74 | 74 | | |
75 | 75 | | |
76 | | - | |
77 | | - | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
| 81 | + | |
| 82 | + | |
| 83 | + | |
| 84 | + | |
78 | 85 | | |
79 | | - | |
| 86 | + | |
80 | 87 | | |
81 | 88 | | |
82 | 89 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
34 | 34 | | |
35 | 35 | | |
36 | 36 | | |
| 37 | + | |
37 | 38 | | |
38 | 39 | | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
39 | 46 | | |
40 | 47 | | |
41 | 48 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
208 | 208 | | |
209 | 209 | | |
210 | 210 | | |
| 211 | + | |
| 212 | + | |
| 213 | + | |
| 214 | + | |
| 215 | + | |
| 216 | + | |
| 217 | + | |
| 218 | + | |
| 219 | + | |
| 220 | + | |
| 221 | + | |
| 222 | + | |
| 223 | + | |
| 224 | + | |
| 225 | + | |
| 226 | + | |
| 227 | + | |
211 | 228 | | |
212 | 229 | | |
213 | 230 | | |
| |||
399 | 416 | | |
400 | 417 | | |
401 | 418 | | |
| 419 | + | |
| 420 | + | |
402 | 421 | | |
403 | 422 | | |
404 | 423 | | |
| |||
1078 | 1097 | | |
1079 | 1098 | | |
1080 | 1099 | | |
| 1100 | + | |
| 1101 | + | |
1081 | 1102 | | |
1082 | 1103 | | |
1083 | 1104 | | |
| |||
1135 | 1156 | | |
1136 | 1157 | | |
1137 | 1158 | | |
| 1159 | + | |
| 1160 | + | |
1138 | 1161 | | |
1139 | 1162 | | |
1140 | 1163 | | |
| |||
0 commit comments