Skip to content

docs(changelog): fourth whole-repo pass over the changelog (#1103) - #1913

Merged
JarryShaw merged 2 commits into
mainfrom
docs/1103d-changelog
Oct 19, 2026
Merged

JarryShaw merged 2 commits into
mainfrom
docs/1103d-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

The fourth whole-repo prose pass of #1103, over the changelog. It changes prose only: every changed .py file's AST is unchanged once string expressions are blanked, except where a docstring is added or vendor template text is edited together with its generated const file.

Missing entries:

  • add 1.5.0 entries for the library, docs-build, conda and vendor-gate
    changes merged after the last recorded one, the LLACode and NTPTimestamp
    breaking changes marked as the file marks them; extend the citation range

Accuracy:

  • the register entry no longer says get's fallback logs CRITICAL, and the
    sentinel entry names the exported Sentinel base
  • correct above/below pointers, a garbled from_data rewrite, doubled
    citations and a stray semicolon; note 1.4.1's TCP(srcport=N) behaviour
  • 1.4.0 records the HOPOPT, IPv6-Opts and HTTP/2 fixes of its TCP change

Polish and rendering:

Refs #1103

Missing entries:
- add 1.5.0 entries for the library, docs-build, conda and vendor-gate
  changes merged after the last recorded one, the LLACode and NTPTimestamp
  breaking changes marked as the file marks them; extend the citation range

Accuracy:
- the register entry no longer says get's fallback logs CRITICAL, and the
  sentinel entry names the exported Sentinel base
- correct above/below pointers, a garbled from_data rewrite, doubled
  citations and a stray semicolon; note 1.4.1's TCP(srcport=N) behaviour
- 1.4.0 records the HOPOPT, IPv6-Opts and HTTP/2 fixes of its TCP change

Polish and rendering:
- owner, not maintainer; misspelled, not misspelt; no "since #621 merged"
- rewrap ragged short source lines, words unchanged
- changelog.rst's notes render as admonitions, not a blockquote
- regenerate CHANGELOG.md

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 19, 2026
@JarryShaw JarryShaw moved this to In review in PyPCAPKit Oct 19, 2026
@JarryShaw

Copy link
Copy Markdown
Owner Author

NEEDS CHANGES at 82a571207. docs/source/changelog/1.5.0.rst:348-349 now says the call returns default "quietly since" #1845. That is timed context, and the parentheses are nested. Suggested fix: say it returns default and logs nothing, and cite #1845/#1873 alongside the other refs. Then regenerate CHANGELOG.md with util/changelog_md.py.

@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 19, 2026
- 1.5.0.rst: the `register` refuses what `get` refuses entry said the
  fallback was quiet "since #1845" inside nested parentheses; it now
  says `get` returns `default` and logs nothing, and cites #1845 and
  #1873 inside the entry's one citation group.
- CHANGELOG.md: regenerated with util/changelog_md.py.
@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 19, 2026
@JarryShaw

Copy link
Copy Markdown
Owner Author

GOOD TO GO at a409479cc. A Sonnet re-review probed get on a miss with a default and found it returns the default with an empty log, which matches the new wording. util/changelog_md.py --check passes, and the commit touches only that entry and its CHANGELOG.md line. The timed-context objection does not apply to this file, because #719 exempts changelog entries from that rule; the rewrite still removes the nested parentheses.

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