Repository navigation
docs: format issue and PR references consistently - #10
Conversation
Issue and PR numbers appear throughout the documentation as provenance — they identify entries in a tracker that is not public and will not resolve from here, and each page that carries them says so. They were not written consistently. Of the thirteen in the rendered markdown, eleven were code-formatted and two were bare: the resolution table in `docs/reviews/README.md`, and the audit note in `docs/THIRD_PARTY_LICENSES.md`. The mismatch was easiest to see in the reviews index, where the note two lines above the table wrote the same number as `gpudge_arc#59` in backticks and the table row wrote it bare. All thirteen are now code-formatted. That note is also a blockquote now, matching the equivalent notes in `CHANGELOG.md` and in the 2026-06-27 report. A reader can meet all three. No prose changes, and nothing outside rendered markdown: the references in Python comments, docstrings and `pyproject.toml` are deliberately left as they are. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
This PR standardizes how private issue/PR provenance tokens (e.g., gpudge_arc#59) are rendered in the documentation by consistently code-formatting them, and aligns the “provenance” note styling in the reviews index with similar notes elsewhere in the docs.
Changes:
- Code-formatted the remaining bare
gpudge_arc#...provenance tokens in rendered markdown. - Converted the provenance note in
docs/reviews/README.mdinto a blockquote for consistency with equivalent notes in other documentation pages.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/THIRD_PARTY_LICENSES.md | Code-formats gpudge_arc#120 as provenance to match other references. |
| docs/reviews/README.md | Formats provenance note as a blockquote and code-formats gpudge_arc#59 in the table row. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request makes minor formatting improvements to the documentation files, specifically wrapping issue references in backticks and converting an explanatory paragraph into a blockquote. No review comments were provided, and I have no feedback to provide.
Issue and PR numbers appear throughout the documentation as provenance —
they identify entries in a tracker that is not public and will not resolve from
here, and each page that carries them says so.
They were not written consistently. Of the thirteen in the rendered markdown,
eleven were code-formatted and two were bare:
docs/reviews/README.mdall 22 addressed in v0.3.1 (gpudge_arc#59)all 22 addressed in v0.3.1 (`gpudge_arc#59`)docs/THIRD_PARTY_LICENSES.mdomitted ... (gpudge_arc#120)omitted ... (`gpudge_arc#120`)The mismatch was easiest to see in the reviews index, where the note two lines
above the table writes the same number as
`gpudge_arc#59`in backticks andthe table row wrote it bare. All thirteen are now code-formatted.
That note is also a blockquote now, matching the equivalent notes in
CHANGELOG.mdand in the 2026-06-27 report — a reader can meet all three.No prose changes, and nothing outside rendered markdown: the references in
Python comments, docstrings and
pyproject.tomlare deliberately left as theyare.
🤖 Generated with Claude Code