Skip to content

Conversation

@uatach
Copy link
Contributor

@uatach uatach commented Sep 11, 2024

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/

@uatach uatach requested a review from erlend-aasland October 28, 2024 21:33
Copy link
Contributor

@erlend-aasland erlend-aasland left a comment

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.

@uatach
Copy link
Contributor Author

uatach commented Dec 2, 2024

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?

@hugovk hugovk changed the title gh-85453: Improve class reference links on datetime.rst gh-140715: Improve class reference links on datetime.rst Dec 22, 2025
@hugovk
Copy link
Member

hugovk commented Dec 22, 2025

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.

@hugovk hugovk added needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes labels Dec 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation in the Doc dir needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes skip news

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

4 participants