Skip to content

Commit bb96e20

Browse files
derek73claude
andcommitted
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>
1 parent b15393d commit bb96e20

3 files changed

Lines changed: 250 additions & 262 deletions

File tree

‎AGENTS.md‎

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -73,10 +73,17 @@ uv run sphinx-build -b html docs dist/docs
7373
# Maintain docs/release_log.rst as changes land:
7474
# - Keep an "Unreleased" entry at the top: `* X.Y.Z - Unreleased`
7575
# - Add one bullet per notable change; prefix with Add/Fix/Remove/Change
76-
# - Reference the issue or PR in parentheses: (#123) or (#123, #124)
77-
# Use "closes #N" when the change directly resolves the issue
76+
# - A bullet is an index, not the record: a bold lead (plain text only --
77+
# RST markup does not nest, so no ``literal`` or role inside ** **), ONE
78+
# before/after example naming the releases it differs from, a limit
79+
# sentence only where a caller would trip on it, then the issue link(s):
80+
# :issue:`123` or :issue:`123`, :issue:`124` (sphinx.ext.extlinks; a PR
81+
# number works too). The mechanism, boundary cases and measurements live
82+
# in the issue and docs/design/decisions.md, never in the bullet --
83+
# 2.4.0's entry was cut from 10,765 words to 1,491 on 2026-10-11
84+
# - Merge bullets a user would see as one change, with several links
7885
# - Version is decided at release time (patch/minor/major per semver)
79-
# - Format matches existing entries — see 1.3.0 block for a current example
86+
# - Format matches existing entries — see the 2.4.0 block for a current example
8087

8188
# Release checklist (PyPI publish is triggered automatically by GitHub Actions on release creation)
8289
# 0. Sweep for stale prose. Grepping for the changed SYMBOL finds almost none of

‎docs/conf.py‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,15 @@
3434
'sphinx.ext.autodoc',
3535
'sphinx.ext.doctest',
3636
'sphinx.ext.viewcode',
37+
'sphinx.ext.extlinks',
3738
]
3839

40+
# :issue:`575` renders as a "#575" link. GitHub redirects /issues/N to
41+
# /pull/N when N is a PR, so the one role serves both.
42+
extlinks = {
43+
'issue': ('https://github.com/derek73/python-nameparser/issues/%s', '#%s'),
44+
}
45+
3946
# Declaration order is canonical in this codebase (Role order drives the
4047
# seven-field order everywhere), so the reference lists members in
4148
# source order, not alphabetically -- Lexicon's vocabulary grouping and

0 commit comments

Comments
 (0)