Skip to content

[3.9] Minor fixes to C API docs (GH-31501) #31526

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

Merged
merged 1 commit into from
Mar 2, 2022

Conversation

JelleZijlstra
Copy link
Member

@JelleZijlstra JelleZijlstra commented 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 [email protected]

Automerge-Triggered-By: GH:JelleZijlstra

* 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 <[email protected]>
@bedevere-bot bedevere-bot added docs Documentation in the Doc dir skip issue skip news labels Feb 23, 2022
@JelleZijlstra JelleZijlstra self-assigned this Feb 28, 2022
@JelleZijlstra JelleZijlstra merged commit 7190617 into python:3.9 Mar 2, 2022
@JelleZijlstra JelleZijlstra deleted the backport-43cf44d-3.9 branch March 2, 2022 04:45
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)
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