Minor fixes to C API docs #31501
Merged
Minor fixes to C API docs #31501
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
It was in the section about warnings, but it makes more sense to put it with PyErr_SetImportError.
It was already documented for PyRun_SimpleFileExFlags.
JelleZijlstra
added
needs backport to 3.9
asvetlov
approved these changes
Feb 22, 2022
|
@gvanrossum I'm planning to merge this PR (docs change by myself, approved by Andrew). |
|
Thanks @JelleZijlstra for the PR 🌮🎉.. I'm working now to backport this PR to: 3.9, 3.10. |
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Feb 23, 2022
* C API docs: move PyErr_SetImportErrorSubclass docs It was in the section about warnings, but it makes more sense to put it with PyErr_SetImportError. * C API docs: document closeit argument to PyRun_AnyFileExFlags It was already documented for PyRun_SimpleFileExFlags. * textual fixes to unicode docs * Move paragraph about tp_dealloc into tp_dealloc section * __aiter__ returns an async iterator, not an awaitable (cherry picked from commit 43cf44d) Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
|
Sorry, @JelleZijlstra, I could not cleanly backport this to |
|
GH-31524 is a backport of this pull request to the 3.10 branch. |
|
GH-31526 is a backport of this pull request to the 3.9 branch. |
JelleZijlstra
added a commit
to JelleZijlstra/cpython
that referenced
this pull request
Feb 23, 2022
* C API docs: move PyErr_SetImportErrorSubclass docs It was in the section about warnings, but it makes more sense to put it with PyErr_SetImportError. * C API docs: document closeit argument to PyRun_AnyFileExFlags It was already documented for PyRun_SimpleFileExFlags. * textual fixes to unicode docs * Move paragraph about tp_dealloc into tp_dealloc section * __aiter__ returns an async iterator, not an awaitable. (cherry picked from commit 43cf44d) Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
miss-islington
added a commit
that referenced
this pull request
Feb 23, 2022
* C API docs: move PyErr_SetImportErrorSubclass docs It was in the section about warnings, but it makes more sense to put it with PyErr_SetImportError. * C API docs: document closeit argument to PyRun_AnyFileExFlags It was already documented for PyRun_SimpleFileExFlags. * textual fixes to unicode docs * Move paragraph about tp_dealloc into tp_dealloc section * __aiter__ returns an async iterator, not an awaitable (cherry picked from commit 43cf44d) Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
JelleZijlstra
added a commit
that referenced
this pull request
Mar 2, 2022
* C API docs: move PyErr_SetImportErrorSubclass docs It was in the section about warnings, but it makes more sense to put it with PyErr_SetImportError. * C API docs: document closeit argument to PyRun_AnyFileExFlags It was already documented for PyRun_SimpleFileExFlags. * textual fixes to unicode docs * Move paragraph about tp_dealloc into tp_dealloc section * __aiter__ returns an async iterator, not an awaitable. (cherry picked from commit 43cf44d)
hello-adam
pushed a commit
to hello-adam/cpython
that referenced
this pull request
Jun 2, 2022
* C API docs: move PyErr_SetImportErrorSubclass docs It was in the section about warnings, but it makes more sense to put it with PyErr_SetImportError. * C API docs: document closeit argument to PyRun_AnyFileExFlags It was already documented for PyRun_SimpleFileExFlags. * textual fixes to unicode docs * Move paragraph about tp_dealloc into tp_dealloc section * __aiter__ returns an async iterator, not an awaitable. (cherry picked from commit 43cf44d)
rhansen
added a commit
to rhansen/cpython
that referenced
this pull request
Oct 19, 2024
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.
JelleZijlstra
pushed a commit
that referenced
this pull request
Oct 21, 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.
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.
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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Various things I noticed while reading through the C API docs.
Happy to back out any changes or create an issue if anything
turns out to be controversial.