Skip to content

docs(docs): second whole-repo pass over the non-API docs and indexes (#1103) - #1802

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

JarryShaw merged 1 commit into
mainfrom
docs/1103b-docs

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

Summary

#1103 second whole-repo pass, docs slice.

tests/project: 950 passed, 1 skipped.

Refs #1103

…1103)

- Accuracy: the protocol hierarchy graph puts IPsec under Internet, not IP,
  and draws IPv6_Ext as the base of every IPv6 extension header, AH, ESP and
  HIP included; ext.rst's shipped-protocol table gains its IPv6_Ext row.
- Accuracy: SeekableReader has 14 positional-only methods, not 13 (_fill,
  #1586); mint-criterion's AppType._missing_ pointer moves to
  apptype.py:2958; the pcapkit-vendor help transcript reads "options:", as
  argparse prints it on every supported Python.
- Directives: versionchanged 1.5.0 on the CLI section, for -P and -L taking
  effect and -L's closed set of layer names (#356).
- Conventions: documentation.rst records that a hand-written .. data:: or
  .. function:: takes the bare name under its .. module::, with :module:
  where the object lives elsewhere (#1775).
- Toctrees: dumpkit lists common, its base-class page, first, as every
  sibling index does.

tests/project: 950 passed, 1 skipped.

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 d6361ffdc. A Sonnet cross-review (author: Opus) found no blocking findings. Scope stays inside the slice, the AST guard is identical against main, and every directive was checked against the release tags. The merged build of all nine second-pass heads has 18 warnings, the same as main. tests/project: 950 passed, 1 skipped, 3 warnings, 3670 subtests passed.

@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 merged commit 917b9a6 into main Oct 15, 2026
13 checks passed
@JarryShaw
JarryShaw deleted the docs/1103b-docs branch October 15, 2026 23:41
@JarryShaw JarryShaw removed 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 Done in PyPCAPKit Oct 16, 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