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.

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

gh-101100: amend references starting with !~ in gh-127054 #127684

Merged
merged 2 commits into from
Dec 6, 2024

Conversation

koyuki7w
Copy link
Contributor

@koyuki7w koyuki7w commented Dec 6, 2024

The references starting with !~ are not rendered correctly (as pointed out in #127054 (comment))


📚 Documentation preview 📚: https://cpython-previews--127684.org.readthedocs.build/

The references starting with `!~` are not rendered correctly
(as pointed out in python#127054 (comment))
@bedevere-app bedevere-app bot added docs Documentation in the Doc dir skip news awaiting review labels Dec 6, 2024
@skirpichev
Copy link
Member

I would rather suggest to revert the datastructures.rst change (and its backports!). Note that before - short method names were used.

CC @vstinner

@picnixz picnixz changed the title Docs: Fixup for PR gh-127054 gh-101100: amend references starting with !~ in gh-127054 Dec 6, 2024
@koyuki7w
Copy link
Contributor Author

koyuki7w commented Dec 6, 2024

@skirpichev The purpose of this change is to suppress sphinx warnings (gh-101100). If the short method names are preferable, I think these should be changed to !append, !pop, etc.

@skirpichev
Copy link
Member

I think these should be changed to !append, !pop, etc.

Ah, indeed. That an option.

@skirpichev skirpichev added needs backport to 3.12 bug and security fixes needs backport to 3.13 bugs and security fixes labels Dec 6, 2024
Copy link
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!

@hugovk hugovk merged commit 77a61c0 into python:main Dec 6, 2024
33 checks passed
@miss-islington-app
Copy link

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

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Dec 6, 2024
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Dec 6, 2024
@bedevere-app
Copy link

bedevere-app bot commented Dec 6, 2024

GH-127692 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 Dec 6, 2024
@bedevere-app
Copy link

bedevere-app bot commented Dec 6, 2024

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

@bedevere-app bedevere-app bot removed the needs backport to 3.12 bug and security fixes label Dec 6, 2024
hugovk pushed a commit that referenced this pull request Dec 6, 2024
…H-127684) (#127692)

gh-101100: amend references starting with `!~` in gh-127054 (GH-127684)
(cherry picked from commit 77a61c0)

Co-authored-by: Yuki Kobayashi <[email protected]>
hugovk pushed a commit that referenced this pull request Dec 6, 2024
…H-127684) (#127693)

gh-101100: amend references starting with `!~` in gh-127054 (GH-127684)
(cherry picked from commit 77a61c0)

Co-authored-by: Yuki Kobayashi <[email protected]>
@koyuki7w koyuki7w deleted the doc-fix-2 branch December 6, 2024 14:25
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 skip news
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

4 participants