The Wayback Machine - https://web.archive.org/web/20211024134917/https://github.com/python/cpython/pull/27989
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

Jump to bottom

bpo-34804: [doc] Rephrase section on side effects in functional.rst for clarity #27989

Merged
merged 4 commits into from Oct 6, 2021
Merged

bpo-34804: [doc] Rephrase section on side effects in functional.rst for clarity #27989

merged 4 commits into from Oct 6, 2021

Conversation

@DonnaDia
Copy link
Contributor

@DonnaDia DonnaDia commented Aug 27, 2021 •
edited by bedevere-bot

https://bugs.python.org/issue34804
@DonnaDia
rephrased the phrase
eba86f8
@the-knights-who-say-ni
Copy link

@the-knights-who-say-ni the-knights-who-say-ni commented Aug 27, 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:

@DonnaDia

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!

zware
zware reviewed Aug 31, 2021
View changes
Doc/howto/functional.rst Outdated
their side effects of sending some text to the screen or pausing execution for a
second.
side effects - such as printing to the screen or writing to a disk file. Another
example - a call to the :func:`print` or :func:`time.sleep` function both return
Copy link
Member

@zware zware Aug 31, 2021

I don't think there needs to be as much change here as is currently in this PR. I like the combination of the first two sentences, but without the added -. I don't think anything needs to change past the newly-combined first sentence.

Copy link
Contributor Author

@DonnaDia DonnaDia Sep 1, 2021

Thanks for your feedback @zware. I've provided new changes

DonnaDia added 2 commits Sep 1, 2021
@DonnaDia
removed extra dashes
3f5198f
@DonnaDia
added a small correction
5fb3b59
@DonnaDia DonnaDia requested a review from zware Sep 1, 2021
@github-actions
Copy link

@github-actions github-actions bot commented Oct 2, 2021

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

@github-actions github-actions bot added the stale label Oct 2, 2021
ambv
ambv reviewed Oct 5, 2021
View changes
Doc/howto/functional.rst Outdated Show resolved Hide resolved
@ambv
Rephrase for punctuation and 79 char limit
86d297f
@ambv ambv changed the title bpo-34804: Repetition of 'for example' in documentation bpo-34804: [doc] Rephrase section on side effects in functional.rst for clarity Oct 6, 2021
@ambv ambv merged commit 7af95a1 into python:main Oct 6, 2021
12 checks passed
@miss-islington
Copy link
Contributor

@miss-islington miss-islington commented Oct 6, 2021

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

@bedevere-bot
Copy link

@bedevere-bot bedevere-bot commented Oct 6, 2021

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

@bedevere-bot
Copy link

@bedevere-bot bedevere-bot commented Oct 6, 2021

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

miss-islington added a commit to miss-islington/cpython that referenced this issue Oct 6, 2021
@DonnaDia @miss-islington
bpo-34804: [doc] Rephrase section on side effects in functional.rst f…
662c379 
…or clarity (pythonGH-27989)

Co-authored-by: Łukasz Langa <[email protected]>
(cherry picked from commit 7af95a1)

Co-authored-by: DonnaDia <[email protected]>
miss-islington added a commit to miss-islington/cpython that referenced this issue Oct 6, 2021
@DonnaDia @miss-islington
bpo-34804: [doc] Rephrase section on side effects in functional.rst f…
a43625a 
…or clarity (pythonGH-27989)

Co-authored-by: Łukasz Langa <[email protected]>
(cherry picked from commit 7af95a1)

Co-authored-by: DonnaDia <[email protected]>
ambv pushed a commit that referenced this issue Oct 6, 2021
@DonnaDia @miss-islington
bpo-34804: [doc] Rephrase section on side effects in functional.rst f…
dcdeb96 
…or clarity (GH-27989) (GH-28762)

Co-authored-by: Łukasz Langa <[email protected]>
(cherry picked from commit 7af95a1)

Co-authored-by: DonnaDia <[email protected]>
ambv pushed a commit that referenced this issue Oct 6, 2021
@DonnaDia @miss-islington
bpo-34804: [doc] Rephrase section on side effects in functional.rst f…
496d1aa 
…or clarity (GH-27989) (GH-28763)

Co-authored-by: Łukasz Langa <[email protected]>
(cherry picked from commit 7af95a1)

Co-authored-by: DonnaDia <[email protected]>
methane added a commit to methane/cpython that referenced this issue Oct 20, 2021
@DonnaDia @ambv @methane
bpo-34804: [doc] Rephrase section on side effects in functional.rst f…
8495e8a 
…or clarity (pythonGH-27989)

Co-authored-by: Łukasz Langa <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ambv ambv

@rhettinger rhettinger

@zware zware

Assignees
No one assigned
Labels
CLA signed skip news stale type-documentation
Projects
None yet
Milestone
No milestone
6 participants
@DonnaDia @the-knights-who-say-ni @miss-islington @bedevere-bot @ambv @zware