Skip to content
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

gh-101100: Fix Sphinx nitpicks in library/collections.abc.rst #113116

Merged
merged 2 commits into from
Dec 14, 2023
Merged

gh-101100: Fix Sphinx nitpicks in library/collections.abc.rst #113116

merged 2 commits into from
Dec 14, 2023

Conversation

AlexWaygood
Copy link
Member

@AlexWaygood AlexWaygood commented Dec 14, 2023 •
edited by github-actions bot
Loading

@bedevere-app bedevere-app bot mentioned this pull request Dec 14, 2023
Open
@AlexWaygood AlexWaygood added skip news needs backport to 3.11 only security fixes needs backport to 3.12 bug and security fixes labels Dec 14, 2023
@rhettinger
Copy link
Contributor

rhettinger commented Dec 14, 2023 •
edited
Loading

Please leave the double-back-ticks as they are now. They were intentionally just inline code and not links which as no value and are distracting to a reader.

@AlexWaygood
Copy link
Member Author

Please leave the double-back-ticks as they are now. They were intentionally just inline code and not links which as no value and are distracting to a reader.

Sure -- I've reverted those changes

rhettinger
rhettinger approved these changes Dec 14, 2023
View reviewed changes
Doc/library/collections.abc.rst Show resolved Hide resolved
Doc/library/collections.abc.rst Outdated Show resolved Hide resolved
Doc/library/collections.abc.rst Outdated Show resolved Hide resolved
Doc/library/collections.abc.rst
testing an interface by verifying the required methods are present
and have not been set to :const:`None`. This only works for simple
interfaces. More complex interfaces require registration or direct
subclassing.

.. [2] Checking ``isinstance(obj, Iterable)`` detects classes that are
registered as :class:`Iterable` or that have an :meth:`__iter__`
Copy link
Contributor

Choose a reason for hiding this comment

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

Same here.

Copy link
Member Author

Choose a reason for hiding this comment

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

I think the added link here (to __iter__ methods) is pertinent and useful, as it relates to the definition of what an iterable is. The other methods in this footnote also have links to their documentation.

Doc/library/collections.abc.rst Show resolved Hide resolved
@AlexWaygood AlexWaygood merged commit 006355b into python:main Dec 14, 2023
25 checks passed
@AlexWaygood AlexWaygood deleted the collections-abc-nitpicks branch December 14, 2023 19:25
@miss-islington-app
Copy link

Thanks @AlexWaygood for the PR 🌮🎉.. I'm working now to backport this PR to: 3.11, 3.12.
🐍🍒⛏🤖 I'm not a witch! I'm not a witch!

@bedevere-app
Copy link

bedevere-app bot commented Dec 14, 2023

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

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Dec 14, 2023
@AlexWaygood @miss-islington
pythongh-101100: Fix Sphinx nitpicks in library/collections.abc.rst (…
73bed9a 
…pythonGH-113116)

(cherry picked from commit 006355b)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
@bedevere-app bedevere-app bot removed the needs backport to 3.12 bug and security fixes label Dec 14, 2023
@bedevere-app
Copy link

bedevere-app bot commented Dec 14, 2023

GH-113137 is a backport of this pull request to the 3.11 branch.

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Dec 14, 2023
@AlexWaygood @miss-islington
pythongh-101100: Fix Sphinx nitpicks in library/collections.abc.rst (…
f0ba6a5 
…pythonGH-113116)

(cherry picked from commit 006355b)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
@bedevere-app bedevere-app bot removed the needs backport to 3.11 only security fixes label Dec 14, 2023
AlexWaygood added a commit that referenced this pull request Dec 14, 2023
@miss-islington @AlexWaygood
[3.12] gh-101100: Fix Sphinx nitpicks in library/collections.abc.rst (
1511451 
GH-113116) (#113136)

gh-101100: Fix Sphinx nitpicks in `library/collections.abc.rst` (GH-113116)
(cherry picked from commit 006355b)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
AlexWaygood added a commit that referenced this pull request Dec 14, 2023
@miss-islington @AlexWaygood
[3.11] gh-101100: Fix Sphinx nitpicks in library/collections.abc.rst (
ba69585 
GH-113116) (#113137)

gh-101100: Fix Sphinx nitpicks in `library/collections.abc.rst` (GH-113116)
(cherry picked from commit 006355b)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
corona10 pushed a commit to corona10/cpython that referenced this pull request Dec 15, 2023
@AlexWaygood @corona10
pythongh-101100: Fix Sphinx nitpicks in library/collections.abc.rst (…
adb433e 
…python#113116)
aisk pushed a commit to aisk/cpython that referenced this pull request Feb 11, 2024
@AlexWaygood @aisk
pythongh-101100: Fix Sphinx nitpicks in library/collections.abc.rst (…
5aec05e 
…python#113116)
Glyphack pushed a commit to Glyphack/cpython that referenced this pull request Sep 2, 2024
@AlexWaygood @Glyphack
pythongh-101100: Fix Sphinx nitpicks in library/collections.abc.rst (…
1e983b1 
…python#113116)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rhettinger rhettinger rhettinger approved these changes

Assignees
No one assigned
Labels
skip news
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@AlexWaygood @rhettinger