Skip to content

docs(protocols): sweep link and transport prose (#1103) - #1761

Merged
JarryShaw merged 2 commits into
mainfrom
docs/1103-linktrans
Oct 15, 2026
Merged

JarryShaw merged 2 commits into
mainfrom
docs/1103-linktrans

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 linktrans slice. It follows the #719 rules: prose only, accuracy first, no churn and no timed context.

Version directives, all 1.5.0 and naming the issue:

  • versionchanged on ARP, InARP, L2TP, VLAN, TCP and UDP.
  • versionadded on L2TPv2, C_Tag, S_Tag and SCTP.

Accuracy:

  • Header tables use the data-model keys: ethernet.*, tcp.options,
    l2tp.version, and the tcp.flags.reserved row on the TCP page.
  • _read_mode_poc names the POC-permitted option; SACK typo fixed.
  • Timed wording dropped: "currently" (7), "as before" (2).

Rendered output:

  • Dead cross-references now resolve: Protocol.* for ProtocolBase.*,
    Protocol.info, apptype.apptype.AppType, VLAN's C_Tag/S_Tag links.
  • Stray quote removed from the FastOpenCookie docstring.
  • TCP, SCTP, Link and Transport pages document the referenced
    helpers, schemas and hooks they were missing.

Checks:

  • An AST guard holds on every changed .py: code is identical once docstrings are blanked.
  • tests/project and every test that reads the edited paths pass.
  • A merged Sphinx build of all nine slices adds no new warnings.
  • A Sonnet cross-review returned GOOD TO GO.

Not covered here; a round-2 PR follows: the autodoc lists of tcp.rst and sctp.rst (checked by script only), and pcapkit/protocols/data/link/** and data/transport/**.

Refs #1103

@JarryShaw JarryShaw added the docs Pull requests that change documentation only (docs: subject prefix) label Oct 15, 2026
@JarryShaw JarryShaw moved this to In review in PyPCAPKit Oct 15, 2026
@JarryShaw

Copy link
Copy Markdown
Owner Author

Verdict: GOOD TO GO at c8f49a3ba. A Sonnet cross-review checked it (author: Opus).

  • Scope and AST guard: 20 files, all inside the slice. All 16 changed .py files are identical once docstrings are blanked, and a negative control confirmed the check catches a real change.
  • Directives: all 10 are correct. The 6 versionchanged sit on names that shipped in 1.4.1.post2; the 4 versionadded sit on names absent from it.
  • Behaviour claims: the ARP and InARP claims were checked by running both trees.
  • Accuracy: more than 30 prose edits were checked, with 0 wrong claims, 0 churn and 0 timed wording.
  • Render: the merged build has no new warnings, and unresolved cross-references on the 14 pages went down.
  • Non-blocking: three cosmetic unresolved links (Self twice and Option.registry) are left for round 2.

@JarryShaw JarryShaw added the review: good-to-go Cross-review at the current head says ready; CI state is separate label Oct 15, 2026
Version directives, all 1.5.0 and naming the issue:
- versionchanged on ARP, InARP, L2TP, VLAN, TCP and UDP.
- versionadded on L2TPv2, C_Tag, S_Tag and SCTP.

Accuracy:
- Header tables use the data-model keys: ethernet.*, tcp.options,
  l2tp.version, and the tcp.flags.reserved row on the TCP page.
- _read_mode_poc names the POC-permitted option; SACK typo fixed.
- Timed wording dropped: "currently" (7), "as before" (2).

Rendered output:
- Dead cross-references now resolve: Protocol.* for ProtocolBase.*,
  Protocol.info, apptype.apptype.AppType, VLAN's C_Tag/S_Tag links.
- Stray quote removed from the FastOpenCookie docstring.
- TCP, SCTP, Link and Transport pages document the referenced
  helpers, schemas and hooks they were missing.

Refs #1103
@github-actions

Copy link
Copy Markdown
Contributor

Coverage: 89.59% (unit tier, Python 3.15, c8f49a3ba, Unit Tests run success)

Package Statements Missed Branches Partial Cover
pcapkit (top level) 104 3 20 3 95.16%
pcapkit/const 18862 954 2368 868 91.06%
pcapkit/corekit 2461 69 780 35 96.54%
pcapkit/dumpkit 276 3 100 3 98.40%
pcapkit/foundation 2915 164 1016 34 93.59%
pcapkit/interface 138 7 52 5 93.68%
pcapkit/protocols 17184 224 4574 189 98.08%
pcapkit/toolkit 872 177 298 8 77.18%
pcapkit/utilities 512 2 158 4 99.10%
pcapkit/vendor 4417 2342 1010 157 43.38%

Per-file detail: the coverage-html artifact of this run.

@JarryShaw
JarryShaw force-pushed the docs/1103-linktrans branch from c8f49a3 to 97ed26c Compare October 15, 2026 17:10
@JarryShaw

Copy link
Copy Markdown
Owner Author

Verdict: GOOD TO GO at 97ed26c03. A Sonnet re-check (author: Opus) after SCTP's versionadded lost its placeholder-module text, per the ruling recorded on #1103. Against c8f49a3ba the range-diff shows only those 3 deleted lines. The AST guard finds 0 of 16 files differ, docutils gives 0 warnings, and the run was 1001 passed, 1 skipped.

@JarryShaw
JarryShaw merged commit 7827cca into main Oct 15, 2026
5 checks passed
@github-project-automation github-project-automation Bot moved this from In review to Done in PyPCAPKit Oct 15, 2026
@JarryShaw
JarryShaw deleted the docs/1103-linktrans branch October 15, 2026 17:14
@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