Skip to content

gh-151070: Fix class referencing typo in collections.abc docs#151088

Merged
serhiy-storchaka merged 2 commits into
python:mainfrom
arshalaromal:fix-issue-151070
Jun 8, 2026
Merged

gh-151070: Fix class referencing typo in collections.abc docs#151088
serhiy-storchaka merged 2 commits into
python:mainfrom
arshalaromal:fix-issue-151070

Conversation

@arshalaromal

@arshalaromal arshalaromal commented Jun 8, 2026 •
edited by bedevere-app Bot
Loading

Copy link
Copy Markdown
Contributor

Fixes #151070

The documentation for collections.abc incorrectly used the :meth: role for Set and Hashable instead of the :class: role. This caused the built HTML documentation to append unintended parentheses () to these class names.

This PR updates the roles to :class: to correctly reference them as classes.

@arshalaromal arshalaromal requested a review from rhettinger as a code owner June 8, 2026 14:38
@python-cla-bot

python-cla-bot Bot commented Jun 8, 2026 •
edited
Loading

Copy link
Copy Markdown

All commit authors signed the Contributor License Agreement.

CLA signed

@bedevere-app bedevere-app Bot mentioned this pull request Jun 8, 2026
Closed
@bedevere-app bedevere-app Bot added docs Documentation in the Doc dir skip news labels Jun 8, 2026
@github-project-automation github-project-automation Bot moved this to Todo in Docs PRs Jun 8, 2026
@read-the-docs-community

read-the-docs-community Bot commented Jun 8, 2026 •
edited
Loading

Copy link
Copy Markdown

Documentation build overview

📚 cpython-previews | 🛠️ Build #33042752 | 📁 Comparing e3305a8 against main (f051c68)

  🔍 Preview build  

1 file changed
± library/collections.abc.html

serhiy-storchaka
serhiy-storchaka approved these changes Jun 8, 2026
View reviewed changes

@serhiy-storchaka serhiy-storchaka left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM.

@serhiy-storchaka serhiy-storchaka merged commit 29a920e into python:main Jun 8, 2026
34 checks passed
@github-project-automation github-project-automation Bot moved this from Todo to Done in Docs PRs Jun 8, 2026
@serhiy-storchaka serhiy-storchaka 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 8, 2026
@miss-islington-app

miss-islington-app Bot commented Jun 8, 2026

Copy link
Copy Markdown

Thanks @arshalaromal for the PR, and @serhiy-storchaka for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13.
🐍🍒⛏🤖

@miss-islington-app

miss-islington-app Bot commented Jun 8, 2026

Copy link
Copy Markdown

Thanks @arshalaromal for the PR, and @serhiy-storchaka for merging it 🌮🎉.. I'm working now to backport this PR to: 3.14.
🐍🍒⛏🤖 I'm not a witch! I'm not a witch!

@miss-islington-app

miss-islington-app Bot commented Jun 8, 2026

Copy link
Copy Markdown

Thanks @arshalaromal for the PR, and @serhiy-storchaka for merging it 🌮🎉.. I'm working now to backport this PR to: 3.15.
🐍🍒⛏🤖

@bedevere-app

bedevere-app Bot commented Jun 8, 2026

Copy link
Copy Markdown

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

@bedevere-app bedevere-app Bot removed the needs backport to 3.13 bugs and security fixes label Jun 8, 2026
@bedevere-app

bedevere-app Bot commented Jun 8, 2026

Copy link
Copy Markdown

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

@bedevere-app bedevere-app Bot removed the needs backport to 3.14 bugs and security fixes label Jun 8, 2026
@bedevere-app

bedevere-app Bot commented Jun 8, 2026

Copy link
Copy Markdown

GH-151110 is a backport of this pull request to the 3.15 branch.

@bedevere-app bedevere-app Bot removed the needs backport to 3.15 pre-release feature fixes, bugs and security fixes label Jun 8, 2026
serhiy-storchaka pushed a commit that referenced this pull request Jun 8, 2026
@miss-islington @arshalaromal
[3.13] gh-151070: Fix class referencing typo in collections.abc docs (G…
de9ed78 
…H-151088) (GH-151108)

(cherry picked from commit 29a920e)

Co-authored-by: Arshal Aromal <arshalaromal19@gmail.com>
serhiy-storchaka pushed a commit that referenced this pull request Jun 8, 2026
@miss-islington @arshalaromal
[3.14] gh-151070: Fix class referencing typo in collections.abc docs (G…
a8003f6 
…H-151088) (GH-151109)

(cherry picked from commit 29a920e)

Co-authored-by: Arshal Aromal <arshalaromal19@gmail.com>
serhiy-storchaka pushed a commit that referenced this pull request Jun 8, 2026
@miss-islington @arshalaromal
[3.15] gh-151070: Fix class referencing typo in collections.abc docs (G…
fd4f9fa 
…H-151088) (GH-151110)

(cherry picked from commit 29a920e)

Co-authored-by: Arshal Aromal <arshalaromal19@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@serhiy-storchaka serhiy-storchaka serhiy-storchaka approved these changes

@rhettinger rhettinger Awaiting requested review from rhettinger rhettinger is a code owner

Assignees

No one assigned

Labels

docs Documentation in the Doc dir skip news

Projects

Docs PRs
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

It's better to use "Set" to refer to class Set than "Set()"

2 participants

@arshalaromal @serhiy-storchaka