Skip to content

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

Open

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
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

    blockedDeferred pending another issue or decision; see the last comment for what unblocks itdocsPull requests that change documentation only (docs: subject prefix)

    Projects

    • Status
      Blocked

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions