Skip to content

bpo-42528: Improve the docs of most Py*_Check{,Exact} API calls. #23602

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
Jan 6, 2021

Conversation

antocuni
Copy link
Contributor

@antocuni antocuni commented Dec 1, 2020

I think that none of these API calls can fail, but only few of them are
documented as such. Add the sentence "This function always succeeds" (which is
the same already used e.g. by PyNumber_Check) to all of them.

https://bugs.python.org/issue42528

I think that none of these API calls can fail, but only few of them are
documented as such. Add the sentence "This function always succeeds" (which is
the same already used e.g. by PyNumber_Check) to all of them.
@the-knights-who-say-ni
Copy link

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).

CLA Missing

Our records indicate the following people have not signed the CLA:

@antocuni

For legal reasons we need all the people listed to sign the CLA before we can look at your contribution. Please follow the steps outlined in the CPython devguide to rectify this issue.

If you have recently signed the CLA, please wait at least one business day
before our records are updated.

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 Dec 1, 2020
@github-actions
Copy link

github-actions bot commented Jan 4, 2021

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 Jan 4, 2021
@antocuni
Copy link
Contributor Author

antocuni commented Jan 5, 2021

The label still says "CLA not signed" but I did. What am I supposed to do?

@Mariatta
Copy link
Member

Mariatta commented Jan 5, 2021

@antocuni can you check the CLA status here: https://check-python-cla.herokuapp.com/ It will change the label for you of the CLA has been signed.

@antocuni
Copy link
Contributor Author

antocuni commented Jan 5, 2021

@antocuni can you check the CLA status here: https://check-python-cla.herokuapp.com/ It will change the label for you of the CLA has been signed.

it worked, thank you!

@github-actions github-actions bot removed the stale Stale PR or inactive for long period of time. label Jan 6, 2021
@vstinner vstinner merged commit 315fc52 into python:master Jan 6, 2021
@vstinner
Copy link
Member

vstinner commented Jan 6, 2021

Merged, thanks @antocuni!

@miss-islington
Copy link
Contributor

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

@miss-islington
Copy link
Contributor

Thanks @antocuni for the PR, and @vstinner for merging it 🌮🎉.. I'm working now to backport this PR to: 3.8.
🐍🍒⛏🤖 I'm not a witch! I'm not a witch!

@bedevere-bot bedevere-bot removed the needs backport to 3.9 only security fixes label Jan 6, 2021
@bedevere-bot
Copy link

GH-24139 is a backport of this pull request to the 3.9 branch.

@miss-islington
Copy link
Contributor

Sorry, @antocuni and @vstinner, I could not cleanly backport this to 3.8 due to a conflict.
Please backport using cherry_picker on command line.
cherry_picker 315fc52db17b19fe30aa9193f26adf69e18d8844 3.8

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jan 6, 2021
…onGH-23602)

I think that none of these API calls can fail, but only few of them are
documented as such. Add the sentence "This function always succeeds" (which is
the same already used e.g. by PyNumber_Check) to all of them.
(cherry picked from commit 315fc52)

Co-authored-by: Antonio Cuni <[email protected]>
vstinner pushed a commit that referenced this pull request Jan 6, 2021
…3602) (GH-24139)

I think that none of these API calls can fail, but only few of them are
documented as such. Add the sentence "This function always succeeds" (which is
the same already used e.g. by PyNumber_Check) to all of them.
(cherry picked from commit 315fc52)

Co-authored-by: Antonio Cuni <[email protected]>

Co-authored-by: Antonio Cuni <[email protected]>
adorilson pushed a commit to adorilson/cpython that referenced this pull request Mar 13, 2021
…onGH-23602)

I think that none of these API calls can fail, but only few of them are
documented as such. Add the sentence "This function always succeeds" (which is
the same already used e.g. by PyNumber_Check) to all of them.
thatbirdguythatuknownot added a commit to thatbirdguythatuknownot/cpython that referenced this pull request Nov 16, 2021
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.

8 participants