Skip to content

gh-101100: Fix Sphinx documentation warnings in collections.rst #130629

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Mar 3, 2025
Merged

gh-101100: Fix Sphinx documentation warnings in collections.rst #130629

merged 1 commit into from
Mar 3, 2025

Conversation

Viicos
Copy link
Contributor

@Viicos Viicos commented Feb 27, 2025 •
edited by github-actions bot
Loading

@bedevere-app bedevere-app bot added docs Documentation in the Doc dir skip news awaiting review labels Feb 27, 2025
@bedevere-app bedevere-app bot mentioned this pull request Feb 27, 2025
Open
Viicos
Viicos commented Feb 27, 2025
View reviewed changes
Doc/library/collections.rst
@@ -894,10 +895,10 @@ they add the ability to access fields by name instead of position index.
Added the *module* parameter.

.. versionchanged:: 3.7
Removed the *verbose* parameter and the :attr:`_source` attribute.
Removed the *verbose* parameter and the :attr:`!_source` attribute.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Should _source be documented?

Copy link
Member

Choose a reason for hiding this comment

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

No need, it's been removed.

@rhettinger rhettinger removed their request for review February 27, 2025 17:12
hugovk
hugovk approved these changes Feb 28, 2025
View reviewed changes
Doc/library/collections.rst
@@ -894,10 +895,10 @@ they add the ability to access fields by name instead of position index.
Added the *module* parameter.

.. versionchanged:: 3.7
Removed the *verbose* parameter and the :attr:`_source` attribute.
Removed the *verbose* parameter and the :attr:`!_source` attribute.
Copy link
Member

Choose a reason for hiding this comment

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

No need, it's been removed.

@hugovk hugovk added needs backport to 3.12 only security fixes needs backport to 3.13 bugs and security fixes labels Mar 3, 2025
@hugovk hugovk merged commit 373eb1b into python:main Mar 3, 2025
39 checks passed
@miss-islington-app
Copy link

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

@github-project-automation github-project-automation bot moved this from Todo to Done in Docs PRs Mar 3, 2025
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Mar 3, 2025
@Viicos @miss-islington
pythongh-101100: Fix Sphinx documentation warnings in `collections.rs…
e684390 
…t` (pythonGH-130629)

(cherry picked from commit 373eb1b)

Co-authored-by: Victorien <65306057+Viicos@users.noreply.github.com>
@bedevere-app
Copy link

bedevere-app bot commented Mar 3, 2025

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

@miss-islington-app
Copy link

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

cherry_picker 373eb1b47af6843678c477b237d787c04dda2818 3.12

@bedevere-app bedevere-app bot removed the needs backport to 3.13 bugs and security fixes label Mar 3, 2025
hugovk pushed a commit that referenced this pull request Mar 3, 2025
@miss-islington @Viicos
[3.13] gh-101100: Fix Sphinx documentation warnings in `collections.r…
f51a748 
…st` (GH-130629) (#130779)

gh-101100: Fix Sphinx documentation warnings in `collections.rst` (GH-130629)
(cherry picked from commit 373eb1b)

Co-authored-by: Victorien <65306057+Viicos@users.noreply.github.com>
hugovk pushed a commit to hugovk/cpython that referenced this pull request Mar 3, 2025
@Viicos @hugovk
[3.12] pythongh-101100: Fix Sphinx documentation warnings in `collect…
8ca209c 
…ions.rst` (pythonGH-130629)

(cherry picked from commit 373eb1b)

Co-authored-by: Victorien <65306057+Viicos@users.noreply.github.com>
@bedevere-app
Copy link

bedevere-app bot commented Mar 3, 2025

GH-130782 is a backport of this pull request to the 3.12 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.12 only security fixes label Mar 3, 2025
hugovk added a commit that referenced this pull request Mar 3, 2025
@hugovk @Viicos
[3.12] gh-101100: Fix Sphinx documentation warnings in `collections.r…
a22cfd4 
…st` (GH-130629) (#130782)

(cherry picked from commit 373eb1b)

Co-authored-by: Victorien <65306057+Viicos@users.noreply.github.com>
@Viicos Viicos deleted the collections-docs-warning branch April 6, 2025 16:43
seehwan pushed a commit to seehwan/cpython that referenced this pull request Apr 16, 2025
@Viicos @seehwan80
pythongh-101100: Fix Sphinx documentation warnings in `collections.rs…
517dcbe 
…t` (python#130629)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@hugovk hugovk hugovk approved these changes

@AA-Turner AA-Turner Awaiting requested review from AA-Turner AA-Turner is a code owner

Assignees

@hugovk hugovk

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.
2 participants
@Viicos @hugovk