Skip to content

gh-140715: Improve class reference links on datetime.rst - #123980

Merged
hugovk merged 13 commits into
python:mainfrom
uatach:audit-links
Mar 1, 2026
Merged

gh-140715: Improve class reference links on datetime.rst#123980
hugovk merged 13 commits into
python:mainfrom
uatach:audit-links

Conversation

@uatach

@uatachuatach commented Sep 11, 2024•
edited by bedevere-app Bot
Loading

Copy link
Copy Markdown
Contributor

Another pull request based on PR #21447, this one is focused on improving class reference links.

📚 Documentation preview 📚: https://cpython-previews--123980.org.readthedocs.build/

@bedevere-appbedevere-appBot added awaiting review docs Documentation in the Doc dir skip news labels Sep 11, 2024
@bedevere-appbedevere-appBot mentioned this pull request Sep 11, 2024
Closed
uatach
uatach commented Sep 11, 2024
View reviewed changes
Comment threadDoc/library/datetime.rst Outdated
uatach
uatach commented Oct 19, 2024
View reviewed changes
Comment threadDoc/library/datetime.rst
erlend-aasland
erlend-aasland reviewed Oct 28, 2024
View reviewed changes

@erlend-aaslanderlend-aasland left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I compared the rendered preview with the existing docs, and there are still quite a few places where I think the link density is too high within a paragraph. I'll jot them down tomorrow or the day after.

Comment threadDoc/library/datetime.rst Outdated
Comment threadDoc/library/datetime.rst Outdated
Comment threadDoc/library/datetime.rst Outdated
@uatach

uatach commented Dec 2, 2024

Copy link
Copy Markdown
ContributorAuthor

I compared the rendered preview with the existing docs, and there are still quite a few places where I think the link density is too high within a paragraph. I'll jot them down tomorrow or the day after.

@erlend-aasland did you have a chance to look into this?

@hugovkhugovk changed the title gh-85453: Improve class reference links on datetime.rstgh-140715: Improve class reference links on datetime.rstDec 22, 2025
@bedevere-appbedevere-appBot mentioned this pull request Dec 22, 2025
Open
5 tasks
@hugovk

hugovk commented Dec 22, 2025

Copy link
Copy Markdown
Member

Thanks for this PR, this is an improvement. If there's more suggestions, we can do that in a followup. But let's merge this as it's been open a while.

Whilst we're here, I'm going to push an update to put the headers in sentence case (see style guide) and will merge tomorrow if no objections.

@hugovkhugovk added needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes labels Dec 22, 2025
@StanFromIreland
StanFromIreland self-requested a review as a code ownerMarch 1, 2026 10:21
@hugovk
hugovk merged commit 6c417e4 into python:mainMar 1, 2026
28 checks passed
@github-project-automationgithub-project-automationBot moved this from Todo to Done in Docs PRsMar 1, 2026
@miss-islington-app

miss-islington-appBot commented Mar 1, 2026

Copy link
Copy Markdown

Thanks @uatach for the PR, and @hugovk for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13, 3.14.
🐍🍒⛏🤖

@miss-islington-app

miss-islington-appBot commented Mar 1, 2026

Copy link
Copy Markdown

Sorry, @uatach and @hugovk, I could not cleanly backport this to 3.14 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker 6c417e44c995eb57e8266e18eb8aeeb2ba0e61ac 3.14

@miss-islington-app

miss-islington-appBot commented Mar 1, 2026

Copy link
Copy Markdown

Sorry, @uatach and @hugovk, I could not cleanly backport this to 3.13 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker 6c417e44c995eb57e8266e18eb8aeeb2ba0e61ac 3.13

hugovk added a commit to hugovk/cpython that referenced this pull request Mar 1, 2026
@uatach@erlend-aasland
@hugovk@StanFromIreland
[3.14]pythongh-140715: Improve class reference links on datetime.rst (…
532e62e
…pythonGH-123980)
(cherry picked from commit 6c417e4)
Co-authored-by: edson duarte <eduarte.uatach@gmail.com>
Co-authored-by: Erlend E. Aasland <erlend@python.org>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
@bedevere-app

bedevere-appBot commented Mar 1, 2026

Copy link
Copy Markdown

GH-145388 is a backport of this pull request to the 3.14 branch.

@bedevere-appbedevere-appBot removed the needs backport to 3.14 bugs and security fixes label Mar 1, 2026
hugovk added a commit to hugovk/cpython that referenced this pull request Mar 1, 2026
@uatach@erlend-aasland
@hugovk@StanFromIreland
[3.13]pythongh-140715: Improve class reference links on datetime.rst (…
1d88eb1
…pythonGH-123980)
(cherry picked from commit 6c417e4)
Co-authored-by: edson duarte <eduarte.uatach@gmail.com>
Co-authored-by: Erlend E. Aasland <erlend@python.org>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
@bedevere-app

bedevere-appBot commented Mar 1, 2026

Copy link
Copy Markdown

GH-145389 is a backport of this pull request to the 3.13 branch.

@bedevere-appbedevere-appBot removed the needs backport to 3.13 bugs and security fixes label Mar 1, 2026
hugovk added a commit that referenced this pull request Mar 10, 2026
@hugovk@uatach
@erlend-aasland@StanFromIreland
[3.14]gh-140715: Improve class reference links on datetime.rst (GH-1…
ed2df30
…23980) (#145388)
Co-authored-by: edson duarte <eduarte.uatach@gmail.com>
Co-authored-by: Erlend E. Aasland <erlend@python.org>
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
hugovk added a commit that referenced this pull request Mar 10, 2026
@hugovk@uatach
@erlend-aasland@StanFromIreland
[3.13]gh-140715: Improve class reference links on datetime.rst (GH-1…
80204f7
…23980) (#145389)
Co-authored-by: edson duarte <eduarte.uatach@gmail.com>
Co-authored-by: Erlend E. Aasland <erlend@python.org>
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
@uatach
uatach deleted the audit-links branch March 18, 2026 21:26
ljfp pushed a commit to ljfp/cpython that referenced this pull request Apr 25, 2026
@uatach@erlend-aasland
@hugovk@StanFromIreland@ljfp
pythongh-140715: Improve class reference links on datetime.rst (pytho…
3ec75ff
…n#123980)
Co-authored-by: Erlend E. Aasland <erlend@python.org>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@picnixzpicnixzpicnixz left review comments
@erlend-aaslanderlend-aaslanderlend-aasland left review comments
@hugovkhugovkhugovk approved these changes
@pgansslepganssleAwaiting requested review from pgansslepganssle is a code owner
@abalkinabalkinAwaiting requested review from abalkin
@StanFromIrelandStanFromIrelandAwaiting requested review from StanFromIrelandStanFromIreland is a code owner

Assignees

@hugovkhugovk

Labels

docsDocumentation in the Doc dirskip news

Projects

Docs PRs
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@uatach@hugovk@picnixz@erlend-aasland@StanFromIreland