Skip to content

[3.10] bpo-43739: Fixing the example code in Doc/extending/extending.rst to declare and initialize the pmodule variable to be of the right type (GH-25207) #25207

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.

Sign up for GitHub

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

Jump to bottom
Merged
rhettinger merged 4 commits into from
Apr 10, 2021
Merged

[3.10] bpo-43739: Fixing the example code in Doc/extending/extending.rst to declare and initialize the pmodule variable to be of the right type (GH-25207) #25207

rhettinger merged 4 commits into from
Apr 10, 2021

Conversation

@shreyanavigyan
Copy link
Contributor

@shreyanavigyan shreyanavigyan commented Apr 6, 2021 •
edited by bedevere-bot
Loading

In the example code of the Extending Python with C/C++ documentation the pmodule variable (that stores the return value of PyImport_ImportModule) was never declared. This PR fixes the problem by declaring and initializing the pmodule variable.

(This PR is for documentation version 3.10.)

Issue URL: https://bugs.python.org/issue43739

https://bugs.python.org/issue43739

@the-knights-who-say-ni
Copy link

the-knights-who-say-ni commented Apr 6, 2021

Hello, and thanks for your contribution!

I'm a bot set up to make sure that the project can legally accept this contribution by verifying everyone involved has signed the PSF contributor agreement (CLA).

Recognized GitHub username

We couldn't find a bugs.python.org (b.p.o) account corresponding to the following GitHub usernames:

@shreyanavigyan

This might be simply due to a missing "GitHub Name" entry in one's b.p.o account settings. This is necessary for legal reasons before we can look at this contribution. Please follow the steps outlined in the CPython devguide to rectify this issue.

You can check yourself to see if the CLA has been received.

Thanks again for the contribution, we look forward to reviewing it!

@bedevere-bot bedevere-bot added docs Documentation in the Doc dir awaiting review labels Apr 6, 2021
@shreyanavigyan shreyanavigyan changed the title [3.10] bpo-43739: Fixing the example code in Doc/extending/extending.rst to declare and initialize the pmodule variable to be of the right type [3.10] bpo-43739: Fixing the example code in Doc/extending/extending.rst to declare and initialize the pmodule variable to be of the right type (GH-25207) Apr 6, 2021
@shreyanavigyan
Copy link
Contributor Author

shreyanavigyan commented Apr 6, 2021 •
edited
Loading

Please have a review of my change in the documentation.

(Note: I have signed the Python CLA recently but I haven't received confirmation yet.)

@shreyanavigyan
Copy link
Contributor Author

shreyanavigyan commented Apr 7, 2021

Please have a review of my PR.

@shreyanavigyan
Copy link
Contributor Author

shreyanavigyan commented Apr 10, 2021 •
edited by bedevere-bot
Loading

Please don't pay attention to the unsuccessful checks . Both Travis CI and Azure Pipelines fail with this error in the Documentation Build :-

python3 tools/rstlint.py ../Misc/NEWS.d/next/
[2] ../Misc/NEWS.d/next/Library/2021-04-10-03-30-36.[bpo-43478](https://bugs.python.org/issue43478).iZcBTq.rst:1: default role used
1 problem with severity 2 found.
Makefile:204: recipe for target 'check' failed
make: *** [check] Error 1

I haven't messed with this file at all but the build fails.

(The same change in the #25330 doesn't result in a error).

@rhettinger rhettinger merged commit ea9b2d6 into python:master Apr 10, 2021
@miss-islington
Copy link
Contributor

miss-islington commented Apr 10, 2021

Thanks @shreyanavigyan for the PR, and @rhettinger for merging it 🌮🎉.. I'm working now to backport this PR to: 3.8.
🐍🍒⛏🤖

@miss-islington
Copy link
Contributor

miss-islington commented Apr 10, 2021

Thanks @shreyanavigyan for the PR, and @rhettinger for merging it 🌮🎉.. I'm working now to backport this PR to: 3.9.
🐍🍒⛏🤖

@shreyanavigyan shreyanavigyan deleted the fix-extending-docs branch April 11, 2021 08:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

docs Documentation in the Doc dir

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@shreyanavigyan @the-knights-who-say-ni @miss-islington @rhettinger @terryjreedy @bedevere-bot