Skip to content

docs: citation, heading and Mermaid forms that depart from documentation.rst #2561

Closed

Description

@JarryShaw

From the 2026-11-01 conventions audit, re-verified on 73add05a3. Each item breaks a written documentation.rst rule; the heading scans were samples, not parses.

Fix: cite what each number is (the issue the PR closes: #2286, #2471, #2268, #1711; #2441 and #2392 close none, so say where the ruling sits); rename or re-case the headings per the verb/gerund line; escape the underscores; tighten the 1103 test to resolve each role's kind, and state its ALLOWED set on the page. Sweep references to every renamed heading ("Renaming a Heading").
Blocked: #2519 (warnings.rst), #2521, #2528, #2537, #2540, #2542, #2543 and #2544 edit pages above; unblocks when all eight merge (gh pr view <n> --json state -q .state prints MERGED).

Activity

  1. added
    docsPull requests that change documentation only (docs: subject prefix)
    blockedDeferred pending another issue or decision; see the last comment for what unblocks it
    on Nov 1, 2026
  2. moved this to Blocked in PyPCAPKiton Nov 1, 2026
  3. JarryShaw commented on Nov 1, 2026

    @JarryShaw
    OwnerAuthor

    Its original blockers have all merged, but the convention pages it sweeps are being edited by the #2557/#2563 stream. Blocked: this unblocks when that stream's PR merges.

  4. added this to the PyPCAPKit v1.6 milestone on Nov 2, 2026
  5. JarryShaw commented on Nov 2, 2026

    @JarryShaw
    OwnerAuthor

    #2599 has merged, so this is unblocked. A worker is on it, applying the citation rule #2599 recorded (cite a PR-thread ruling by the issue the PR closes, or by :pr: with "no issue holds the ruling"). It also fixes protocol-layer-placement.rst's :issue:2343``, since #2343 is a pull request.

  6. added
    wipWork in flight - a covering PR is open or an agent is actively on it
    and removed
    blockedDeferred pending another issue or decision; see the last comment for what unblocks it
    on Nov 2, 2026
  7. moved this from Blocked to WIP in PyPCAPKiton Nov 2, 2026
  8. JarryShaw commented on Nov 2, 2026

    @JarryShaw
    OwnerAuthor

    The citation sweep is done locally. A Sonnet review asked for two fixes: cite #2495 for the const-crawler ruling, and re-case the title of sslv3.rst, which #2602 added. Both are being fixed now.

    Needs deciding: the new citation-kind test. It checks each :issue:/:pr: role against a saved list of every issue and PR number. The list stops at #2614, and #2615 already falls outside it.

    1. Strict as built: a citation of an unrecorded number fails until someone adds the number by hand.
    2. Check recorded numbers strictly and skip any number above the list's maximum. A util/ script regenerates the list on demand.
    3. Option 2, plus a networked CI step that checks the numbers above the list's maximum against GitHub.

    Recommendation: 2. Most docs changes cite a recent number, so option 1 would tax about half of future docs PRs. Option 2 still catches the error this test exists for, a PR number cited as an issue, once a refresh records the number. Option 3 adds another workflow to maintain. The fix round implements 2 unless you choose otherwise.

  9. added
    needs: decisionWaiting on the maintainer to decide — not blocked by other work
    on Nov 2, 2026
  10. JarryShaw commented on Nov 2, 2026

    @JarryShaw
    OwnerAuthor

    take 2 and the regeneration should be a scheduled job.

  11. JarryShaw commented on Nov 2, 2026

    @JarryShaw
    OwnerAuthor

    The owner chose 2, paraphrased: the test checks recorded numbers strictly and skips numbers above the snapshot's maximum. The owner also asked for the snapshot to be regenerated by a scheduled job rather than by hand.

    The fix round adds that job, a scheduled and manually dispatchable workflow that runs the util/ refresh script. Because main is protected, it opens or updates a PR whenever the snapshot changes. It is documented on workflows.rst.

  12. removed
    needs: decisionWaiting on the maintainer to decide — not blocked by other work
    on Nov 2, 2026
  13. removed
    wipWork in flight - a covering PR is open or an agent is actively on it
    on Nov 2, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsPull requests that change documentation only (docs: subject prefix)

    Projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions