Skip to content

docs(changelog): second-round concision pass over 1.5.0 (#719) - #1088

Merged
JarryShaw merged 1 commit into
mainfrom
docs/719-r2-changelog
Oct 6, 2026
Merged

JarryShaw merged 1 commit into
mainfrom
docs/719-r2-changelog

Conversation

@JarryShaw

@JarryShaw JarryShaw commented Oct 6, 2026 •

Copy link
Copy Markdown
Owner

Please follow the guide below

What is the purpose of your pull request?

  • docs — documentation only

Description of your pull request and other information

Second-round #719 pass over docs/source/changelog/**. Only 1.5.0.rst changes. The released versions' files needed no typo or markup fixes.

  • 73 of 167 entries tightened. Prose goes from 206,467 to 177,757 characters (13.9%). Cut: test tallies, sweep and fuzz counts, review history. Kept: rejected alternatives, exceptions, ruled-out causes, breaking notes, migration paths.
  • The entry count is unchanged at 167. Every entry keeps its :issue:/:pr:/:rfc: citations (514 total).
  • Fixed claims the code contradicts: the intro's citation range, fix(corekit): make EnumRegistry.get's no-default marker an identity sentinel (#857) #859's "not yet landed", a Flags.get('NOPE', 0) example that fix(corekit): stop EnumRegistry.get's default from minting #868 invalidated, a superseded TransportProtocol bound, and three moved docs paths.
  • CHANGELOG.md regenerated; util/changelog_md.py --check reports it in step. Sphinx -n warnings match main exactly, with 0 on changelog pages.

@JarryShaw JarryShaw added docs Pull requests that change documentation only (docs: subject prefix) review: running A cross-review is in flight against the current head - no verdict yet labels Oct 6, 2026
@JarryShaw

Copy link
Copy Markdown
Owner Author

Cross-review verdict on 0a1b4bba7: NEEDS CHANGES (ran on Sonnet; author Opus)

The mechanical claims hold:

  • There are 167 entries on both sides.
  • No entry's set of :issue:/:pr:/:rfc: references changed.
  • 266 distinct numbers are cited, from 121 to 1050.
  • The four factual corrections were probed and hold: fix(corekit): make EnumRegistry.get's no-default marker an identity sentinel (#857) #859 merged; Flags.get('NOPE', 0) raises EnumKeyError; the TransportProtocol bound is gone; the moved docs paths exist.
  • changelog_md.py --check is in step, and tests/project passes (379).

But the cuts drop design reasons that the #719 rule says to keep. Restore one clause each for:

Spot-checked by me: "seniority", "sees only 35", "namespace the call itself creates" and the git checkout -- step each appear once on main and 0 times on the PR.

@JarryShaw JarryShaw added review: needs-changes Cross-review at the current head says changes are required; see the verdict comment and removed review: running A cross-review is in flight against the current head - no verdict yet labels Oct 6, 2026
* Tightens 73 of the 167 entries in `docs/source/changelog/1.5.0.rst`
  (prose 206,467 -> 177,757 characters, 13.9%; 2807 -> 2449 lines).
  Cut: test and subtest tallies, sweep and fuzz counts, review history,
  and restatement. Kept: rejected alternatives, deliberate exceptions,
  ruled-out causes, breaking-change notes and migration paths.
* Entry count unchanged at 167; every `:issue:`/`:pr:`/`:rfc:` citation
  kept per entry (514 before and after).
* Corrects claims the code contradicts: the intro's citation range, the
  "not yet landed" #859 sentinel, a `Flags.get` default example #868
  invalidated, a superseded `TransportProtocol` bound, and three moved
  docs paths.
* Regenerated `CHANGELOG.md` with `util/changelog_md.py`.

tests/project: 379 passed, 1 skipped. Sphinx -n warnings identical to main.
@JarryShaw
JarryShaw force-pushed the docs/719-r2-changelog branch from 0a1b4bb to 09d735c Compare October 6, 2026 17:32
@JarryShaw JarryShaw added review: running A cross-review is in flight against the current head - no verdict yet and removed review: needs-changes Cross-review at the current head says changes are required; see the verdict comment labels Oct 6, 2026
@JarryShaw

Copy link
Copy Markdown
Owner Author

Cross-review verdict on 09d735c27: GOOD TO GO (ran on Sonnet; author Opus, round 2)

All nine required restorations from the previous verdict are back and read cleanly: #618, #678, #838, #620, #872, #875, #866, the engine keyword and #692. The three lighter ones are also back: #675, #668 and #647.

Spot-checked by me: the phrases dropped in round one are present again.

Pre-existing and out of scope: the #647 line still calls TransportProtocol an IntFlag.

@JarryShaw JarryShaw added review: good-to-go Cross-review at the current head says ready; CI state is separate and removed review: running A cross-review is in flight against the current head - no verdict yet labels Oct 6, 2026
@JarryShaw
JarryShaw merged commit fd0fb05 into main Oct 6, 2026
26 checks passed
@JarryShaw
JarryShaw deleted the docs/719-r2-changelog branch October 6, 2026 17:40
@JarryShaw JarryShaw removed the review: good-to-go Cross-review at the current head says ready; CI state is separate label Oct 6, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Pull requests that change documentation only (docs: subject prefix)

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

1 participant