Skip to content

docs(changelog): third whole-repo pass over the changelog (#1103) - #1829

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

JarryShaw merged 1 commit into
mainfrom
docs/1103c-changelog

Conversation

@JarryShaw

Copy link
Copy Markdown
Owner

Please follow the guide below

  • You will be asked some questions, please read them carefully and answer honestly

  • Put an x into all the boxes [ ] relevant to your pull request (like that [x])

  • Use Preview tab to see how your pull request will actually look like

  • Searched for similar pull requests

  • Followed the coding style (make pylint, make mypy, make isort)

  • make test passes, and a test case covers the change. Narrow runs only, listed below.

  • Added a changelog entry under docs/source/changelog/ and regenerated CHANGELOG.md, if the change is user-visible: this PR is the changelog pass

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

Third whole-repo pass over the changelog for #1103.

Tests: tests/project passed.

Refs #1103

Entries:
- record the merged fixes the 1.5.0 file lacked: the PadN padding
  change, the data and schema re-exports, register validation and
  Command.get, the JSON report test, MANIFEST.in, the count pins, the
  Mermaid rendering, the CLI help and the Conda packaging.

Counts:
- 1.5.0 states no tallies of codebase or docs items; measurements that
  justify a choice and code constants stay.

Released changelogs:
- date the Extractor unsupported-call raise and the #155 fix to 1.1.1,
  and record the renames 1.1.1.post2 carried;
- correct the 1.3.0 EngineBase, 0.16.0 module path and 1.0.0 diffstat
  claims, and list the TCP construction fixes 1.4.0 shipped.

Markup: wrap a bare TCP:80/8080 that autolinked, fix section signs and
an issue citation; CHANGELOG.md regenerated.

Refs #1103
@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 16, 2026
@JarryShaw JarryShaw moved this to In review in PyPCAPKit Oct 16, 2026
@JarryShaw
JarryShaw merged commit 34a494b into main Oct 16, 2026
37 checks passed
@JarryShaw
JarryShaw deleted the docs/1103c-changelog branch October 16, 2026 19:54
@github-project-automation github-project-automation Bot moved this from In review to Done in PyPCAPKit Oct 16, 2026
@JarryShaw JarryShaw removed the review: running A cross-review is in flight against the current head - no verdict yet label Oct 16, 2026
@JarryShaw

Copy link
Copy Markdown
Owner Author

Verdict: NEEDS CHANGES at be78b27c2 (merged as 34a494b1f). A Sonnet cross-review (author: Opus) confirmed every tag attribution, the new 1.5.0 entries, and that CHANGELOG.md is exact generator output. It found defects in the count rewrite:

  • 1.5.0.rst:2389: a continuation line lost its indent, which splits the HIP bullet and adds two docutils warnings (reproduced in a clean Sphinx build);
  • garbled rewrites at lines ~140, ~1087 and ~2276, and an overclaim at ~2536 (ENCAP_TYPE_TO_LINKTYPE excludes unmapped encapsulations);
  • the preamble stops at b12, but b13 is out;
  • "broken since 0.16.3" for Reassembly not working since 0.16.3 #155 should read 1.0.0, both in 1.1.1.rst and in the index;
  • counts remain in 1.5.0.rst.

A worker is preparing a docs-only follow-up commit for main.

@JarryShaw

Copy link
Copy Markdown
Owner Author

Fixed on main in e5f7fb66b. Changes:

  • the HIP bullet indent is restored, so docutils reports no warnings;
  • the garbled rewrites are repaired;
  • ENCAP_TYPE_TO_LINKTYPE is scoped to encapsulations whose DLT has a LinkType member;
  • the preamble runs to b13 (2026-10-16), and Reassembly not working since 0.16.3 #155 dates the breakage to 1.0.0;
  • the remaining counts are removed, keeping only measurements and spec quantities.

A Sonnet re-review found one new overclaim: "any other built-in is still refused" is false for the dumper registrars. I reproduced it, since register_dumper('json', XML) is accepted with a warning. The entry is now scoped to the engine, reassembly and traceflow registrars. changelog_md.py --check passes.

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