Skip to content

Docs: improve class references linking in functions.rst#150891

Open
m-aciek wants to merge 1 commit into
python:mainfrom
m-aciek:docs-library-functions-ref-links-fixes
Open

Docs: improve class references linking in functions.rst#150891
m-aciek wants to merge 1 commit into
python:mainfrom
m-aciek:docs-library-functions-ref-links-fixes

Conversation

@m-aciek
Copy link
Copy Markdown
Contributor

@m-aciek m-aciek commented Jun 3, 2026

With Linklint we link only first reference in a paragraph. Explicitly leave only reference which is expected to link.

In dict, frozendict, frozenset and set reference docs.

Before:

Zrzut ekranu 2026-06-3 o 23 49 34 Zrzut ekranu 2026-06-3 o 23 57 08 Zrzut ekranu 2026-06-3 o 23 57 31 Zrzut ekranu 2026-06-3 o 23 57 58

After:

Zrzut ekranu 2026-06-4 o 00 51 35 Zrzut ekranu 2026-06-4 o 00 51 54 Zrzut ekranu 2026-06-4 o 00 52 04 Zrzut ekranu 2026-06-4 o 00 52 21

With Linklint we link only first reference in a paragraph. Explicitly leave only reference which is expected to link.

In dict, frozendict, frozenset and set reference docs.
@read-the-docs-community
Copy link
Copy Markdown

Documentation build overview

📚 cpython-previews | 🛠️ Build #32981211 | 📁 Comparing 96954f7 against main (7a468a1)

  🔍 Preview build  

1 file changed
± library/functions.html

@hugovk hugovk added needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes needs backport to 3.15 pre-release feature fixes, bugs and security fixes labels Jun 4, 2026
Copy link
Copy Markdown
Member

@hugovk hugovk left a comment

Choose a reason for hiding this comment

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

Thanks!

@nedbat Although I wonder if linklint could prefer linking the instances in a "See x [and y]" sentence, or would that be unreliable?

@nedbat
Copy link
Copy Markdown
Member

nedbat commented Jun 4, 2026

As I read these paragraphs, I wonder what value these sentences actually add:

  • "The [dict] object is the dictionary class."
  • "[frozenset] is a built-in class."

About linklint: it's an interesting idea to preserve links in "See ..." sentences. I wonder if it is reliable enough, and if there are other sentence structures to consider. Also, what about translations?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

awaiting merge docs Documentation in the Doc dir needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes needs backport to 3.15 pre-release feature fixes, bugs and security fixes skip issue skip news

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

4 participants