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

Doc: C API: Move tp_dealloc paragraph to tp_dealloc section #125737

Merged
merged 1 commit into from
Oct 21, 2024

Conversation

rhansen
Copy link
Contributor

@rhansen rhansen commented Oct 19, 2024

It looks like commit 43cf44d (gh-31501) accidentally moved the paragraph to the tp_finalize section when the intent was to move it to the tp_dealloc section (according to the commit message).

Also:

  • Convert the paragraph to a warning.
  • Apply the appropriate font style to tp_dealloc.
  • Unlinkify the first mention of tp_dealloc since the paragraph is already in the tp_dealloc section.

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

It looks like commit 43cf44d
(pythongh-31501) accidentally moved the paragraph to the `tp_finalize`
section when the intent was to move it to the `tp_dealloc` section
(according to the commit message).

Also:
  * Convert the paragraph to a warning.
  * Apply the appropriate font style to `tp_dealloc`.
  * Unlinkify the first mention of `tp_dealloc` since the paragraph is
    already in the `tp_dealloc` section.
@bedevere-app bedevere-app bot added docs Documentation in the Doc dir skip news awaiting review labels Oct 19, 2024
@rhansen
Copy link
Contributor Author

rhansen commented Oct 19, 2024

cc @JelleZijlstra

fiona02

This comment was marked as off-topic.

Copy link
Member

@JelleZijlstra JelleZijlstra left a comment

Choose a reason for hiding this comment

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

Thanks, does seem like I put this paragraph in the wrong place.

@JelleZijlstra JelleZijlstra added needs backport to 3.12 bug and security fixes needs backport to 3.13 bugs and security fixes skip issue labels Oct 21, 2024
@JelleZijlstra JelleZijlstra merged commit d880c83 into python:main Oct 21, 2024
32 checks passed
@miss-islington-app
Copy link

Thanks @rhansen for the PR, and @JelleZijlstra 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 Oct 21, 2024
…onGH-125737)

It looks like commit 43cf44d
(pythongh-31501) accidentally moved the paragraph to the `tp_finalize`
section when the intent was to move it to the `tp_dealloc` section
(according to the commit message).

(cherry picked from commit d880c83)

Co-authored-by: Richard Hansen <rhansen@rhansen.org>
Also: * Convert the paragraph to a warning.
  * Apply the appropriate font style to `tp_dealloc`.
  * Unlinkify the first mention of `tp_dealloc` since the paragraph is
    already in the `tp_dealloc` section.
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Oct 21, 2024
…onGH-125737)

It looks like commit 43cf44d
(pythongh-31501) accidentally moved the paragraph to the `tp_finalize`
section when the intent was to move it to the `tp_dealloc` section
(according to the commit message).

(cherry picked from commit d880c83)

Co-authored-by: Richard Hansen <rhansen@rhansen.org>
Also: * Convert the paragraph to a warning.
  * Apply the appropriate font style to `tp_dealloc`.
  * Unlinkify the first mention of `tp_dealloc` since the paragraph is
    already in the `tp_dealloc` section.
@bedevere-app
Copy link

bedevere-app bot commented Oct 21, 2024

GH-125798 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 Oct 21, 2024
@bedevere-app
Copy link

bedevere-app bot commented Oct 21, 2024

GH-125799 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 Oct 21, 2024
JelleZijlstra pushed a commit that referenced this pull request Oct 21, 2024
GH-125737) (#125799)

Doc: C API: Move `tp_dealloc` paragraph to `tp_dealloc` section (GH-125737)

It looks like commit 43cf44d
(gh-31501) accidentally moved the paragraph to the `tp_finalize`
section when the intent was to move it to the `tp_dealloc` section
(according to the commit message).

(cherry picked from commit d880c83)

Co-authored-by: Richard Hansen <rhansen@rhansen.org>
JelleZijlstra pushed a commit that referenced this pull request Oct 21, 2024
GH-125737) (#125798)


It looks like commit 43cf44d
(gh-31501) accidentally moved the paragraph to the `tp_finalize`
section when the intent was to move it to the `tp_dealloc` section
(according to the commit message).

(cherry picked from commit d880c83)


Co-authored-by: Richard Hansen <rhansen@rhansen.org>
ebonnal pushed a commit to ebonnal/cpython that referenced this pull request Jan 12, 2025
…on#125737)

It looks like commit 43cf44d
(pythongh-31501) accidentally moved the paragraph to the `tp_finalize`
section when the intent was to move it to the `tp_dealloc` section
(according to the commit message).

Also:
  * Convert the paragraph to a warning.
  * Apply the appropriate font style to `tp_dealloc`.
  * Unlinkify the first mention of `tp_dealloc` since the paragraph is
    already in the `tp_dealloc` section.
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 issue skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants