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: Fix dangling refs in bdb.rst #114983

Merged
merged 4 commits into from
Feb 11, 2024
Merged

gh-101100: Fix dangling refs in bdb.rst #114983

merged 4 commits into from
Feb 11, 2024

Conversation

smontanaro
Copy link
Contributor

@smontanaro smontanaro commented Feb 4, 2024

This should be fairly straightforward. I did one thing that isn't maybe strictly kosher. The Bdb.quitting attribute isn't directly documented, but is mentioned in the description of Bdb.set_quit(). I linked those occurrences to the description of set_quit.


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

Doc/library/bdb.rst Outdated Show resolved Hide resolved
Copy link
Member

@serhiy-storchaka serhiy-storchaka left a comment

Choose a reason for hiding this comment

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

LGTM.

@hugovk
Copy link
Member

hugovk commented Feb 10, 2024

@smontanaro Please could you update this PR to remove bdb.rst from .nitignore?

Congratulations! You improved:

Doc/library/bdb.rst

Please remove from Doc/tools/.nitignore

@hugovk hugovk added needs backport to 3.11 only security fixes needs backport to 3.12 bug and security fixes labels Feb 10, 2024
@smontanaro
Copy link
Contributor Author

@hugovk Should be all set. If my aim at the start of one of these mini-projects is to get rid of all warnings from a file, should my initial PR remove it from .nitignore?

@hugovk
Copy link
Member

hugovk commented Feb 11, 2024

Yes please, we can consider each PR to be atomic so both (clean file, remove from .nitignore) are needed for the CI to pass, and the CI must pass for us to be able to merge.

@hugovk hugovk merged commit 1b89591 into python:main Feb 11, 2024
23 checks passed
@miss-islington-app
Copy link

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

@miss-islington-app
Copy link

Sorry, @smontanaro 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 1b895914742d20ccebd1b56b1b0936b7e00eb95e 3.12

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Feb 11, 2024
(cherry picked from commit 1b89591)

Co-authored-by: Skip Montanaro <[email protected]>
Co-authored-by: AN Long <[email protected]>
@bedevere-app
Copy link

bedevere-app bot commented Feb 11, 2024

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

@bedevere-app bedevere-app bot removed the needs backport to 3.11 only security fixes label Feb 11, 2024
hugovk pushed a commit that referenced this pull request Feb 11, 2024
gh-101100: Fix dangling refs in bdb.rst (GH-114983)
(cherry picked from commit 1b89591)

Co-authored-by: Skip Montanaro <[email protected]>
Co-authored-by: AN Long <[email protected]>
smontanaro added a commit to smontanaro/cpython that referenced this pull request Feb 11, 2024
@smontanaro
Copy link
Contributor Author

Cherries have been picked. I think I finally created the pull request against the correct branch (3.12). Given the standardized naming of the backport branch, it does seem peculiar that GitHub can't default to the relevant branch though...

@bedevere-app
Copy link

bedevere-app bot commented Feb 11, 2024

GH-115297 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 Feb 11, 2024
@AlexWaygood
Copy link
Member

Cherries have been picked. I think I finally created the pull request against the correct branch (3.12). Given the standardized naming of the backport branch, it does seem peculiar that GitHub can't default to the relevant branch though...

Looks great! There was just one thing missing: a backport PR to the 3.12 branch has to have a PR title starting with [3.12] in order for bedevere to recognise it as a PR backporting this PR. I changed the title for you on #115297 :)

hugovk pushed a commit that referenced this pull request Feb 11, 2024
Co-authored-by: AN Long <[email protected]>
Fix dangling refs in bdb.rst (#114983)
fsc-eriker pushed a commit to fsc-eriker/cpython that referenced this pull request Feb 14, 2024
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
None yet
Development

Successfully merging this pull request may close these issues.

5 participants