Skip to content

docs(changelog): add the missing 1.5.0 entries and fix its markup (#1103) - #1767

Merged
JarryShaw merged 1 commit into
mainfrom
docs/1103-changelog
Oct 15, 2026
Merged

JarryShaw merged 1 commit into
mainfrom
docs/1103-changelog

Conversation

@JarryShaw

Copy link
Copy Markdown
Owner

Please follow the guide below

What is the purpose of your pull request?

Tick the commit type your subject line carries.

  • fix — corrects a defect
  • feat — adds a feature
  • perf — changes performance, not behaviour
  • refactor — changes neither behaviour nor performance
  • test — tests only
  • docs — documentation only
  • ci — workflows or build tooling
  • release — bumps the version or rolls up a distribution
  • chore — anything else

Description

Part of #1103, the whole-repository prose sweep, for the changelog slice. It follows the #719 rules: prose only, accuracy first, no churn and no timed context.

Entries:

  • add 69 entries for merged changes the 1.5.0 file did not cite, most of
    them from fix(ipv6-opts): RPL option 0x23 raises AttributeError in _read_opt_unassigned #1196 on: the round-trip fixes, reassembly, the engines,
    registration, the config module, and the corekit moves
  • add a pcapkit.interface section for its new registry helpers
  • cover breaking changes the file had missed: AppType.proto,
    TransportProtocol's base, TLSKeyLabel's move, Method.get case, the
    sentinels, the all extra, IPv6_Ext and register_mh_extension

Accuracy:

  • the ftp/http case-folding entry notes that Method.get matches case
  • the construction-keyword entry says a keyword passed to from_data raises

Preamble:

  • re-measure the citation figures and list the 1.5.0b4 to b12 prereleases
  • drop the "as of this revision" snapshot wording

Markup:

  • un-nest seven inline literals from bold, and close an unterminated literal
  • regenerate CHANGELOG.md with util/changelog_md.py

Conventions:

  • re-pin process.rst's changelog figures to 10 sections and 269 entries

Checks:

  • An AST guard holds on every changed .py file.
  • process.rst pin. This PR also re-pins the changelog figures in process.rst (lines 101–111) to the measured 269 entries and 10 sections. The docs PR edits only lines 45 and 320 of that file, so the two merge cleanly.
  • tests/project gives 930 passed and 1 skipped, and every test that reads the edited paths passes.
  • A merged Sphinx build of all nine slices adds no new warnings.
  • A Sonnet cross-review sent this back once. After the fix round, a re-check returned GOOD TO GO.

Not covered here; a round-2 PR follows: about 80 uncited user-visible PRs from before #1195; the stale #759, #1016 and #417 (pycrate) entries; 1.5.0.rst lines 1100–2040 and 2220–2640; and changelog.rst.

Refs #1103

)

Entries:
- add 69 entries for merged changes the 1.5.0 file did not cite, most of
  them from #1196 on: the round-trip fixes, reassembly, the engines,
  registration, the config module, and the corekit moves
- add a pcapkit.interface section for its new registry helpers
- cover breaking changes the file had missed: AppType.proto,
  TransportProtocol's base, TLSKeyLabel's move, Method.get case, the
  sentinels, the all extra, IPv6_Ext and register_mh_extension

Accuracy:
- the ftp/http case-folding entry notes that Method.get matches case
- the construction-keyword entry says a keyword passed to from_data raises

Preamble:
- re-measure the citation figures and list the 1.5.0b4 to b12 prereleases
- drop the "as of this revision" snapshot wording

Markup:
- un-nest seven inline literals from bold, and close an unterminated literal
- regenerate CHANGELOG.md with util/changelog_md.py

Conventions:
- re-pin process.rst's changelog figures to 10 sections and 269 entries

Refs #1103
@JarryShaw JarryShaw added the docs Pull requests that change documentation only (docs: subject prefix) label Oct 15, 2026
@JarryShaw

Copy link
Copy Markdown
Owner Author

Verdict: GOOD TO GO at 4ad13e42f. A Sonnet cross-review checked it (author: Opus), after one fix round.

  • First review, two blocking findings: the all-extra entry said four engines; and process.rst was not re-pinned, which made two tests/project tests fail.
  • Re-check: both are fixed.
    • The entry now names the three engines and two crawler packages that 1.4.x all carried, checked against all four 1.4.x tags.
    • process.rst is pinned to the measured 269 entries and 10 sections, and the two tests now pass.
    • CHANGELOG.md is in step with --check.
  • Tests: tests/project gives 930 passed.
  • Non-blocking: the protocols: implement NGAP over SCTP, decoding aligned PER through pycrate #417 entry says pycrate is excluded from all, but all now includes it; round 2 fixes it.

@JarryShaw JarryShaw added the review: good-to-go Cross-review at the current head says ready; CI state is separate label Oct 15, 2026
@JarryShaw JarryShaw moved this to In review in PyPCAPKit Oct 15, 2026
@JarryShaw
JarryShaw merged commit cf78da8 into main Oct 15, 2026
36 checks passed
@JarryShaw
JarryShaw deleted the docs/1103-changelog branch October 15, 2026 17:18
@github-project-automation github-project-automation Bot moved this from In review to Done in PyPCAPKit Oct 15, 2026
@JarryShaw JarryShaw removed the review: good-to-go Cross-review at the current head says ready; CI state is separate label Oct 15, 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