Skip to content
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

Fix documentation #13721

Merged
merged 3 commits into from
Jun 5, 2019
Merged

Fix documentation #13721

merged 3 commits into from
Jun 5, 2019

Conversation

bentyeh
Copy link
Contributor

@bentyeh bentyeh commented Jun 1, 2019

Based on the source code

cpython/Lib/multiprocessing/pool.py

Line 755 in 4a68650

raise ValueError("{0!r} not ready".format(self))
AsyncResult.successful() raises a ValueError, not an AssertionError.

@bentyeh
Fix documentation
8325ab5 
Based on the source code (https://github.com/python/cpython/blob/4a686504eb2bbf69adf78077458508a7ba131667/Lib/multiprocessing/pool.py#L755), AsyncResult.successful() raises a ValueError, not an AssertionError.
@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 your contribution by verifying you have signed the PSF contributor agreement (CLA).

Unfortunately we couldn't find an account corresponding to your GitHub username on bugs.python.org (b.p.o) to verify you have signed the CLA (this might be simply due to a missing "GitHub Name" entry in your b.p.o account settings). This is necessary for legal reasons before we can look at your 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 your contribution, we look forward to reviewing it!

@bedevere-bot bedevere-bot added docs Documentation in the Doc dir awaiting review labels Jun 1, 2019
@mangrisano
Copy link
Contributor

I'm not a core-dev but it looks good to me. I don't know if it is required to open an issue on the tracker. @csabella what's the behavior in this case? Thank you and sorry for the mention!

tirkarthi
tirkarthi approved these changes Jun 4, 2019
View reviewed changes
Copy link
Member

@tirkarthi tirkarthi left a comment

Choose a reason for hiding this comment

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

LGTM. It seems similar changes were done in bd73e72 to change assert statements and use proper exceptions and messages though docs were not updated. Thanks.

tirkarthi
tirkarthi reviewed Jun 4, 2019
View reviewed changes
Copy link
Member

@tirkarthi tirkarthi left a comment

Choose a reason for hiding this comment

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

Please add a versionchanged directive along with this change since it was changed in 3.7 and above with versions below 3.7 raising AssertionError and it's clarified better that it is 3.7+ only change.

@bentyeh
Fix documentation: add versionchanged directive
8465385 
Add a `versionchanged` directive to specify that change from an `AssertionError` to a `ValueError` exception is a 3.7+ only change.
@bentyeh
Remove unnecessary whitespace
6430b79
asvetlov
asvetlov approved these changes Jun 4, 2019
View reviewed changes
Copy link
Contributor

@asvetlov asvetlov left a comment

Choose a reason for hiding this comment

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

LGTM.

I'd like to postpone the merging until "Backport to 3.8" github label is added.

@miss-islington miss-islington merged commit d4cf099 into python:master Jun 5, 2019
@miss-islington
Copy link
Contributor

Sorry, I can't merge this PR. Reason: Base branch was modified. Review and try the merge again..

@miss-islington
Copy link
Contributor

Thanks @bentyeh for the PR 🌮🎉.. I'm working now to backport this PR to: 3.8.
🐍🍒⛏🤖 I'm not a witch! I'm not a witch!

@bedevere-bot
Copy link

GH-13836 is a backport of this pull request to the 3.8 branch.

miss-islington added a commit that referenced this pull request Jun 5, 2019
@miss-islington @bentyeh
Fix documentation (GH-13721)
f2054d9 
Based on the source code https://github.com/python/cpython/blob/4a686504eb2bbf69adf78077458508a7ba131667/Lib/multiprocessing/pool.pyGH-L755 AsyncResult.successful() raises a ValueError, not an AssertionError.
(cherry picked from commit d4cf099)

Co-authored-by: Benjamin Yeh <bentyeh@users.noreply.github.com>
DinoV pushed a commit to DinoV/cpython that referenced this pull request Jan 14, 2020
@bentyeh @DinoV
Fix documentation (pythonGH-13721)
ae830e6 
Based on the source code https://github.com/python/cpython/blob/4a686504eb2bbf69adf78077458508a7ba131667/Lib/multiprocessing/pool.py#L755 AsyncResult.successful() raises a ValueError, not an AssertionError.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tirkarthi tirkarthi tirkarthi approved these changes

@asvetlov asvetlov asvetlov approved these changes

Assignees
No one assigned
Labels
docs Documentation in the Doc dir skip issue skip news
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@bentyeh @the-knights-who-say-ni @mangrisano @miss-islington @bedevere-bot @asvetlov @tirkarthi