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.

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

Simple Documentation fix: Missing link to return type class. #21291

Merged
merged 2 commits into from
Jul 20, 2020

Conversation

Volker-Weissmann
Copy link
Contributor

@Volker-Weissmann Volker-Weissmann commented Jul 3, 2020

Just a simple documentation fix: apply_async and map_async return a "multiprocessing.pool.AsyncResult Object", not a "result object".

https://bugs.python.org/issue17805

Automerge-Triggered-By: @csabella

@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:

@Volker-Weissmann

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!

Copy link
Contributor

@remilapeyre remilapeyre left a comment

Choose a reason for hiding this comment

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

Hi @Volker-Weissmann, thanks for improving the documentation!

While it is not always required for simple documentation changes, the CLA will be needed if you want to contribute more significant changes to Python in the future so please follow the advice of @the-knights-who-say-ni to sign it :-)

Also, the documentation wraps the lines at 80 characters, can you please update your PR so that it's consistent with the rest of the file?

@Volker-Weissmann
Copy link
Contributor Author

I signed the CLA a few minutes ago and added a line break.

@remilapeyre
Copy link
Contributor

remilapeyre commented Jul 3, 2020

Thanks, also bpo-17805 is not exactly related to this change. As it is a simple documentation change, a bpo entry may not be required but we should not use another one that is not strictly this issue. I think you can just change the title of the PR to something like "Add link in multiprocessing documentation".

@Volker-Weissmann Volker-Weissmann changed the title bpo-17805: Simple Documentation fix Simple Documentation fix: Missing link to return type class. Jul 3, 2020
Copy link
Contributor

@remilapeyre remilapeyre left a comment

Choose a reason for hiding this comment

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

Thanks!

Copy link
Contributor

@csabella csabella left a comment

Choose a reason for hiding this comment

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

LGTM. Thank you for the contribution!

@miss-islington
Copy link
Contributor

Thanks @Volker-Weissmann for the PR 🌮🎉.. I'm working now to backport this PR to: 3.8, 3.9.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jul 20, 2020
…H-21291)

Just a simple documentation fix: apply_async and map_async return a "multiprocessing.pool.AsyncResult Object", not a "result object".
(cherry picked from commit f9bf015)

Co-authored-by: Volker-Weissmann <[email protected]>
@bedevere-bot bedevere-bot removed the needs backport to 3.9 only security fixes label Jul 20, 2020
@bedevere-bot
Copy link

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

@bedevere-bot
Copy link

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

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jul 20, 2020
…H-21291)

Just a simple documentation fix: apply_async and map_async return a "multiprocessing.pool.AsyncResult Object", not a "result object".
(cherry picked from commit f9bf015)

Co-authored-by: Volker-Weissmann <[email protected]>
miss-islington added a commit that referenced this pull request Jul 20, 2020
Just a simple documentation fix: apply_async and map_async return a "multiprocessing.pool.AsyncResult Object", not a "result object".
(cherry picked from commit f9bf015)

Co-authored-by: Volker-Weissmann <[email protected]>
miss-islington added a commit that referenced this pull request Jul 20, 2020
Just a simple documentation fix: apply_async and map_async return a "multiprocessing.pool.AsyncResult Object", not a "result object".
(cherry picked from commit f9bf015)

Co-authored-by: Volker-Weissmann <[email protected]>
arun-mani-j pushed a commit to arun-mani-j/cpython that referenced this pull request Jul 21, 2020
…H-21291)

Just a simple documentation fix: apply_async and map_async return a "multiprocessing.pool.AsyncResult Object", not a "result object".
shihai1991 pushed a commit to shihai1991/cpython that referenced this pull request Aug 4, 2020
…H-21291)

Just a simple documentation fix: apply_async and map_async return a "multiprocessing.pool.AsyncResult Object", not a "result object".
shihai1991 pushed a commit to shihai1991/cpython that referenced this pull request Aug 20, 2020
…H-21291)

Just a simple documentation fix: apply_async and map_async return a "multiprocessing.pool.AsyncResult Object", not a "result object".
xzy3 pushed a commit to xzy3/cpython that referenced this pull request Oct 18, 2020
…H-21291)

Just a simple documentation fix: apply_async and map_async return a "multiprocessing.pool.AsyncResult Object", not a "result object".
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.

7 participants