Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

gh-101100: Fix Py_DEBUG dangling references#115003

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged
AlexWaygood merged 8 commits intopython:mainfromsmontanaro:doc-fix-pydebug
Feb 7, 2024

Conversation

smontanaro
Copy link
Contributor

@smontanarosmontanaro commentedFeb 4, 2024
edited by github-actionsbot
Loading

Per conversation with@AlexWaygood, here is a small proposed fix to a few broken Py_DEBUG links. My suggestion was to reference the_debug-build anchor. Aside from that, all this does so far is suppress danglingPy_DEBUG references in the same paragraphs where the_debug-build anchor is referenced.


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

@AlexWaygood
Copy link
Member

AlexWaygood commentedFeb 4, 2024
edited
Loading

It seems like this PR also includes all the changes from your unrelated other PR:

Was that intentional? Perhaps you had your branch for that PR checked out, instead of yourmain branch, before creating this branch locally? That would mean that this PR branch would "branch off" from that branch, instead of from yourmain branch :)

@smontanaro
Copy link
ContributorAuthor

sigh I just branched from my main. Apologies.

Not sure how to proceed at this point.

@AlexWaygood
Copy link
Member

sigh I just branched from my main. Apologies.

Not sure how to proceed at this point.

I fixed things up for you by pushing to your branch (you'll have togit pull locally to update your local clone and make further updates locally 🙂).

I don't work much with the C API, so I don't have strong opinions on the C API docs -- it'd be great if@serhiy-storchaka might be able to take a look at this one

@smontanaro
Copy link
ContributorAuthor

Thanks Alex. I'll review and see what else looks like it needs to be changed.

As an aside, I saw a GitHub Actions warning which was new to me:

Screenshot 2024-02-04 at 1 28 29 PM

Is there maybe a parsing problem in whatever tool is involved in that particular GitHub action?

@smontanaro
Copy link
ContributorAuthor

Oh, maybe it's complaining about the section below the message, not above it.

AlexWaygood reacted with thumbs up emoji

@AlexWaygood
Copy link
Member

As an aside, I saw a GitHub Actions warning which was new to me:
Screenshot 2024-02-04 at 1 28 29 PM

Is there maybe a parsing problem in whatever tool is involved in that particular GitHub action?

That is warning you about a separate dangling reference later on in the same paragraph (line 820). It's fine to leave that reference warning unsolved in this PR. The reason why you're seeing the warning in the "files changed" tab in this PR is because you have made other changes to that paragraph

@smontanaro
Copy link
ContributorAuthor

That is warning you about a separate dangling reference later on in the same paragraph (line 820). It's fine to leave that reference warning unsolved in this PR. The reason why you're seeing the warning in the "files changed" tab in this PR is because you have made other changes to that paragraph

Too late. I will revert it if it's a deal breaker, but I see no reason that it needs to actually be documented in Python's documentation.

AlexWaygood reacted with thumbs up emoji

@AlexWaygood
Copy link
Member

Too late. I will revert it if it's a deal breaker, but I see no reason that it needs to actually be documented in Python's documentation.

I don't think it's a deal-breaker :)

Copy link
Member

@serhiy-storchakaserhiy-storchaka left a comment

Choose a reason for hiding this comment

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

It would be nice to add thePy_DEBUG macro to the index.

Add the.. macro:: Py_DEBUG directive, look what index is generated for it, and add the same index with the.. index:: directive.

@smontanaro
Copy link
ContributorAuthor

@serhiy-storchaka I added an explicit:c:macro: PyDEBUG target inintro.rst and referenced it fromtest.rst. This generates both an anchor for other references and an index entry.

While I was at it, I simplified the text intest.rst. Since it already refers the reader to the debug build details inusing/configure.rst, I saw no reason to actually duplicate theconfigure command example here.

Copy link
Member

@AlexWaygoodAlexWaygood left a comment

Choose a reason for hiding this comment

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

Looks great!

@AlexWaygoodAlexWaygood added needs backport to 3.11only security fixes needs backport to 3.12only security fixes labelsFeb 7, 2024
@AlexWaygoodAlexWaygood merged commitd0322fd intopython:mainFeb 7, 2024
@miss-islington-app
Copy link

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

miss-islington pushed a commit to miss-islington/cpython that referenced this pull requestFeb 7, 2024
…5003)(cherry picked from commitd0322fd)Co-authored-by: Skip Montanaro <skip.montanaro@gmail.com>
@miss-islington-app
Copy link

Sorry,@smontanaro and@AlexWaygood, I could not cleanly backport this to3.11 due to a conflict.
Please backport usingcherry_picker on command line.

cherry_picker d0322fdf2c1a7292a43959fe5a572d783b88a1c4 3.11

@bedevere-app
Copy link

GH-115135 is a backport of this pull request to the3.12 branch.

@bedevere-appbedevere-appbot removed the needs backport to 3.12only security fixes labelFeb 7, 2024
AlexWaygood pushed a commit that referenced this pull requestFeb 7, 2024
…#115135)gh-101100: Fix Py_DEBUG dangling Sphinx references (GH-115003)(cherry picked from commitd0322fd)Co-authored-by: Skip Montanaro <skip.montanaro@gmail.com>
@bedevere-app
Copy link

GH-115141 is a backport of this pull request to the3.11 branch.

@bedevere-appbedevere-appbot removed the needs backport to 3.11only security fixes labelFeb 7, 2024
AlexWaygood pushed a commit that referenced this pull requestFeb 7, 2024
…115141)gh-101100: Fix Py_DEBUG dangling Sphinx references (#115003)(cherry picked from commitd0322fd)
fsc-eriker pushed a commit to fsc-eriker/cpython that referenced this pull requestFeb 14, 2024
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

@serhiy-storchakaserhiy-storchakaserhiy-storchaka approved these changes

@AlexWaygoodAlexWaygoodAlexWaygood approved these changes

Assignees

@AlexWaygoodAlexWaygood

Labels
docsDocumentation in the Doc dirskip news
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

3 participants
@smontanaro@AlexWaygood@serhiy-storchaka

[8]ページ先頭

©2009-2025 Movatter.jp