Skip to content

docs: prose sweep after the defect wave (schema-data) (#1103) - #1179

Merged
JarryShaw merged 1 commit into
mainfrom
docs/1103-schema-data
Oct 7, 2026
Merged

JarryShaw merged 1 commit into
mainfrom
docs/1103-schema-data

Conversation

@JarryShaw

Copy link
Copy Markdown
Owner
  • Searched for similar pull requests
  • Followed the coding style (make pylint, make mypy, make isort) — not run; comment-only change, AST guard below
  • make test passes, and a test case covers the change — per-module runs below; prose only
  • Added a changelog entry — N/A, added centrally

What is the purpose of your pull request?

  • docs — documentation only

Description of your pull request and other information

Part of #1103. Slice schema-data: the wave's prose in pcapkit/protocols/schema/, pcapkit/protocols/data/, corekit/fields/misc.py and corekit/protochain.py (15 files).

One fix: MesgIDOption.seconds in schema/internet/mh.py said "seconds since January 1st, 1970". It is an RFC 1305 NTP count from 1900, which is why post_process (edited by the wave) subtracts 2_208_988_800. NTPTimestamp.seconds in the protocol module already says 1900.

Every other wave-added comment was checked against the code and left alone, including the SchemaField.unpack NOTE (checked against prepare), the Quick-Start width NOTE (8 octets in the schema, RFC 4782 §3.2) and the ContextRequestOption note (a probe confirmed the SchemaWarning and zero padding).

File AST equal
pcapkit/protocols/schema/internet/mh.py True

Tests: test_mh_unit.py 52 passed; test_mh_mesg_id_fraction_unit.py 4 passed; tests/project 389 passed, 1 skipped.

MesgIDOption.seconds is an RFC 1305 NTP second count, which post_process
rebases by 2,208,988,800 s; its comment named the 1970 UNIX epoch.

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

Copy link
Copy Markdown
Owner Author

Cross-review verdict on 1e3f8b717: GOOD TO GO (ran on Sonnet; author Opus). Labelled review: good-to-go.

  • The 1900 epoch is correct. post_process subtracts 2_208_988_800 (25,567 days), _make_opt_mesg_id (mh.py:8110) adds it back, and RFC 4285 §6.1 specifies an RFC 1305 NTP timestamp. I re-read the encoder line myself.
  • The PMIPv6 timestamp is separate. The one at schema/internet/mh.py:1140 really is on the 1970 epoch, and this PR leaves it untouched.
  • Prose only. The AST guard shows no code change.
  • Tests: test_mh_unit.py 52 passed; tests/project 389 passed.

@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 7, 2026
@github-actions

github-actions Bot commented Oct 7, 2026

Copy link
Copy Markdown
Contributor

Coverage: 88.89% (unit tier, Python 3.14, 1e3f8b717, Unit Tests run success)

Package Statements Missed Branches Partial Cover
pcapkit (top level) 104 4 20 4 93.55%
pcapkit/const 18757 1034 2342 845 90.24%
pcapkit/corekit 1878 91 580 22 94.34%
pcapkit/dumpkit 142 0 42 0 100.00%
pcapkit/foundation 2442 102 852 39 94.38%
pcapkit/interface 112 7 40 5 92.11%
pcapkit/protocols 15707 188 3974 163 98.19%
pcapkit/toolkit 487 65 144 1 85.42%
pcapkit/utilities 429 4 122 4 98.55%
pcapkit/vendor 4409 2359 1006 158 42.84%

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

@JarryShaw
JarryShaw merged commit f24eb27 into main Oct 7, 2026
41 checks passed
@github-project-automation github-project-automation Bot moved this from In review to Done in PyPCAPKit Oct 7, 2026
@JarryShaw
JarryShaw deleted the docs/1103-schema-data branch October 7, 2026 14:26
@JarryShaw JarryShaw removed the review: good-to-go Cross-review at the current head says ready; CI state is separate label Oct 7, 2026
@JarryShaw JarryShaw added this to the PyPCAPKit v1.5 milestone Oct 25, 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