Skip to content

bpo-43327: Fix the docs for PyImport_ImportFrozenModuleObject() #24659

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 2 commits into from
Nov 27, 2022

Conversation

ZackerySpytz
Copy link
Contributor

@ZackerySpytz ZackerySpytz commented Feb 26, 2021

The docs state that PyImport_ImportFrozenModuleObject() returns a
new reference, but it actually returns an int.

The name of this function's first parameter must be specified in
Doc/data/refcounts.dat. The line for the name parameter will
correspond to the function's return value if the parameter name is
not given (as mentioned in a comment at the top of
Doc/data/refcounts.dat).

https://bugs.python.org/issue43327

Automerge-Triggered-By: GH:kumaraditya303

The docs state that PyImport_ImportFrozenModuleObject() returns a
new reference, but it actually returns an int.

The name of this function's first parameter must be specified in
Doc/data/refcounts.dat.  The line for the name parameter will
correspond to the function's return value if the parameter name is
not given (as mentioned in a comment at the top of
Doc/data/refcounts.dat).
@github-actions
Copy link

This PR is stale because it has been open for 30 days with no activity.

@github-actions github-actions bot added the stale Stale PR or inactive for long period of time. label Mar 29, 2021
Copy link
Contributor

@MaxwellDupre MaxwellDupre left a comment

Choose a reason for hiding this comment

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

Looks right to me.

@github-actions github-actions bot removed the stale Stale PR or inactive for long period of time. label Aug 4, 2022
@kumaraditya303 kumaraditya303 added docs Documentation in the Doc dir skip news labels Nov 27, 2022
@kumaraditya303 kumaraditya303 added needs backport to 3.10 only security fixes needs backport to 3.11 only security fixes labels Nov 27, 2022
@miss-islington
Copy link
Contributor

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

@bedevere-bot
Copy link

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

@bedevere-bot bedevere-bot removed the needs backport to 3.11 only security fixes label Nov 27, 2022
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Nov 27, 2022
…onGH-24659)

The docs stated that PyImport_ImportFrozenModuleObject() returns a
new reference, but it actually returns an int.

(cherry picked from commit 62a5dc1)

Co-authored-by: Zackery Spytz <[email protected]>
Co-authored-by: Kumar Aditya <[email protected]>
@bedevere-bot
Copy link

GH-99808 is a backport of this pull request to the 3.10 branch.

@bedevere-bot bedevere-bot removed the needs backport to 3.10 only security fixes label Nov 27, 2022
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Nov 27, 2022
…onGH-24659)

The docs stated that PyImport_ImportFrozenModuleObject() returns a
new reference, but it actually returns an int.

(cherry picked from commit 62a5dc1)

Co-authored-by: Zackery Spytz <[email protected]>
Co-authored-by: Kumar Aditya <[email protected]>
miss-islington added a commit that referenced this pull request Nov 27, 2022
…4659)

The docs stated that PyImport_ImportFrozenModuleObject() returns a
new reference, but it actually returns an int.

(cherry picked from commit 62a5dc1)

Co-authored-by: Zackery Spytz <[email protected]>
Co-authored-by: Kumar Aditya <[email protected]>
miss-islington added a commit that referenced this pull request Nov 27, 2022
…4659)

The docs stated that PyImport_ImportFrozenModuleObject() returns a
new reference, but it actually returns an int.

(cherry picked from commit 62a5dc1)

Co-authored-by: Zackery Spytz <[email protected]>
Co-authored-by: Kumar Aditya <[email protected]>
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.

7 participants