Skip to content

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

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
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
Loading

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

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!

@bedevere-bot bedevere-bot added awaiting review docs Documentation in the Doc dir labels Aug 27, 2021
zware
zware reviewed Aug 31, 2021
View reviewed 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

Choose a reason for hiding this comment

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

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

Choose a reason for hiding this comment

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

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

@DonnaDia DonnaDia requested a review from zware September 1, 2021 16:08
@github-actions
Copy link

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 Stale PR or inactive for long period of time. label Oct 2, 2021
ambv
ambv reviewed Oct 5, 2021
View reviewed changes
@ambv ambv added skip news needs backport to 3.9 only security fixes needs backport to 3.10 only security fixes labels Oct 5, 2021
@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
@miss-islington
Copy link
Contributor

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

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

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

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

@bedevere-bot bedevere-bot removed the needs backport to 3.9 only security fixes label Oct 6, 2021
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request 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 <lukasz@langa.pl>
(cherry picked from commit 7af95a1)

Co-authored-by: DonnaDia <37962843+DonnaDia@users.noreply.github.com>
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request 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 <lukasz@langa.pl>
(cherry picked from commit 7af95a1)

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

Co-authored-by: Łukasz Langa <lukasz@langa.pl>
(cherry picked from commit 7af95a1)

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

Co-authored-by: Łukasz Langa <lukasz@langa.pl>
(cherry picked from commit 7af95a1)

Co-authored-by: DonnaDia <37962843+DonnaDia@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ambv ambv ambv left review comments

@rhettinger rhettinger Awaiting requested review from rhettinger

@zware zware Awaiting requested review from zware

Assignees
No one assigned
Labels
docs Documentation in the Doc dir skip news stale Stale PR or inactive for long period of time.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@DonnaDia @the-knights-who-say-ni @miss-islington @bedevere-bot @ambv @zware