Skip to content

docs(docs): third whole-repo pass over the non-API docs (#1103) - #1832

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

JarryShaw merged 1 commit into
mainfrom
docs/1103c-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

Counted numbers:

  • conventions, roadmap, workflow, release, index and package-index pages
    state no counts of codebase or docs items; measurements, spec values and
    code constants stay
  • documentation.rst states the no-counts rule in place of "re-derive a
    count", and no longer claims its sibling pages carry figure tests

Accuracy:

  • the Create Release gate runs only once version_check has passed
  • the Test Results footnotes no longer say measured engines were unbuilt
  • mint-criterion's unmint split no longer contradicts itself

Rendering:

  • pep.rst cross-references point at documented targets; third-party
    modules with no inventory render as literals
  • the layer and foundation base-class pages get distinct titles, and the
    root page has a single top-level heading
  • release_status outcomes and the conventions index read as lists

Directives:

  • link/index.rst records the removed link-layer OSPF, RARP and DRARP names

Non-prose check: ast.dump is unchanged once docstrings are blanked; any workflow, TOML or script edits are comment-only (parsed and compared). Narrow test runs are green (tests/project and the tests that read edited files).

Refs #1103

Counted numbers:
- conventions, roadmap, workflow, release, index and package-index pages
  state no counts of codebase or docs items; measurements, spec values and
  code constants stay
- documentation.rst states the no-counts rule in place of "re-derive a
  count", and no longer claims its sibling pages carry figure tests

Accuracy:
- the Create Release gate runs only once version_check has passed
- the Test Results footnotes no longer say measured engines were unbuilt
- mint-criterion's unmint split no longer contradicts itself

Rendering:
- pep.rst cross-references point at documented targets; third-party
  modules with no inventory render as literals
- the layer and foundation base-class pages get distinct titles, and the
  root page has a single top-level heading
- release_status outcomes and the conventions index read as lists

Directives:
- link/index.rst records the removed link-layer OSPF, RARP and DRARP names

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 bd1d3cd into main Oct 16, 2026
36 checks passed
@github-project-automation github-project-automation Bot moved this from In review to Done in PyPCAPKit Oct 16, 2026
@JarryShaw
JarryShaw deleted the docs/1103c-docs branch October 16, 2026 20:14
@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 599f3281e (merged as bd1d3cd2d). A Sonnet cross-review (author: Opus) confirmed:

  • the Create Release gate wording against create-release.yml;
  • the Test Results footnotes and the mint-criterion reconciliation;
  • every changed cross-reference target, against the base objects.inv;
  • the distinct page titles;
  • the OSPF/RARP/DRARP versionremoved, against v1.4.1's __init__.py exports;
  • the documentation.rst rewrite, against test_conventions_doc_claims.py, and that the file passes (36 passed, 1 skipped).

One blocking defect, which I re-checked by parsing the workflow. releasing.rst:394 and :405 now apply to every publishing job, but github has neither !cancelled() nor needs.version_check.result == 'success' in its if:. Only tag, pypi and conda do. The fix is to name those three jobs. There are a few grammar nits as well. A worker is preparing a docs-only follow-up for main.

@JarryShaw

Copy link
Copy Markdown
Owner Author

Fixed on main in 5d86fcbf2. releasing.rst now names tag, pypi and conda, the jobs whose if: carries !cancelled() and version_check == 'success'. The grammar nits are fixed, and footnotes that annotated measured cells are dropped from index.rst. A Sonnet re-review returned GOOD TO GO: it parsed the workflow and confirmed that the reflow is whitespace-only apart from the named changes and that the footnote numbering matches.

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