Skip to content

docs: harmonize PR/issue refs in release notes#866

Merged
FabianHofmann merged 2 commits into
masterfrom
docs/harmonize-release-note-refs
Jul 24, 2026
Merged

docs: harmonize PR/issue refs in release notes#866
FabianHofmann merged 2 commits into
masterfrom
docs/harmonize-release-note-refs

Conversation

@FabianHofmann

Copy link
Copy Markdown
Collaborator

Harmonizing the PR/issue references in the release notes so they render consistently as clickable short-refs instead of a mix of bare URLs and inconsistent RST link forms.

Note

The following content was generated by AI.

Changes proposed in this Pull Request

  • Convert bare GitHub URLs in the Upcoming Version and 0.8.0 sections to the canonical anonymous RST short-ref form `#NNN <url>`__ (renders as a clickable #NNN).
  • Normalize single-underscore named references (`_) to anonymous double-underscore (`__). Labels like #580 and #776 appear more than once; named references with duplicate link text emit "duplicate target name" build warnings, anonymous references do not.
  • Linkify the plain, unlinked #580 mentions.
  • Fix a stray Markdown link ([here](...)) in the 0.1.4 notes that rendered literally in RST, converting it to an RST external link.

Documentation-only change; no code or behavior is affected.

Checklist

  • AI-generated content is marked (see AGENTS.md).
  • Code changes are sufficiently documented; i.e. new functions contain docstrings and further explanations may be given in doc.
  • Unit tests for new features were added (if applicable).
  • A note for the release notes doc/release_notes.rst of the upcoming release is included.
  • I consent to the release of this PR's code under the MIT license.

Convert bare GitHub URLs and mixed RST link forms to a single
anonymous linked short-ref form (`#NNN <url>`__) across the Upcoming
and 0.8.0 sections, linkify plain #580 mentions, and fix a stray
Markdown link in the 0.1.4 notes.
@codspeed-hq

codspeed-hq Bot commented Jul 24, 2026

Copy link
Copy Markdown

Merging this PR will not alter performance

✅ 173 untouched benchmarks
⏩ 173 skipped benchmarks1


Comparing docs/harmonize-release-note-refs (aa79ebb) with master (e295723)

Open in CodSpeed

Footnotes

  1. 173 benchmarks were skipped, so the baseline results were used instead. If they were deleted from the codebase, click here and archive them to remove them from the performance reports.

Trace each previously unreferenced entry in the Upcoming Version
section to its introducing PR and append the linked short-ref,
so every bullet is traceable (#718, #566, #780, #783, #790,
#801, #802, #824, #860).
@FabianHofmann
FabianHofmann merged commit 2afe5d0 into master Jul 24, 2026
24 checks passed
@FabianHofmann
FabianHofmann deleted the docs/harmonize-release-note-refs branch July 24, 2026 08:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants