Skip to content

bpo-28681: Clarify multiple function names in the tutorial - #21340

Merged
nanjekyejoannah merged 2 commits into
python:masterfrom
nanjekyejoannah:issue28681
Jul 6, 2020
Merged

bpo-28681: Clarify multiple function names in the tutorial#21340
nanjekyejoannah merged 2 commits into
python:masterfrom
nanjekyejoannah:issue28681

Conversation

@nanjekyejoannah

@nanjekyejoannahnanjekyejoannah commented Jul 5, 2020•
edited by bedevere-bot
Loading

Copy link
Copy Markdown
Contributor

Merged ideas from @bitdancer and @terryjreedy in the bpo thread.

https://bugs.python.org/issue28681

@bedevere-botbedevere-bot added docs Documentation in the Doc dir awaiting core review labels Jul 5, 2020
terryjreedy
terryjreedy requested changes Jul 6, 2020
View reviewed changes

@terryjreedyterryjreedy left a comment •
edited
Loading

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Approved with the addition of 'also' to the part I wrote. Re-reading, I find it a bit jarring without the addition. Thank you for attending to this.

Comment threadDoc/tutorial/controlflow.rst Outdated
@bedevere-bot

bedevere-bot commented Jul 6, 2020

Copy link
Copy Markdown

When you're done making the requested changes, leave the comment: I have made the requested changes; please review again.

@nanjekyejoannah@terryjreedy
Add also
dac2d86
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
@terryjreedyterryjreedy changed the title bpo-28681: About function renaming in the tutorialbpo-28681: Clarify multiple function names in the tutorialJul 6, 2020
@terryjreedy

terryjreedy commented Jul 6, 2020

Copy link
Copy Markdown
Member

Guido strongly prefers and the devguide now clearly states that the first message line of a merged commit should be an active tense statement, like the first line of docstrings. (I would say "Should start with an active verb" except that there might be a short introductory phrase.) This is easier to ensure if the default, the PR title, is written that way. Hence my edit.

@terryjreedyterryjreedy mentioned this pull request Jul 6, 2020
Merged
@nanjekyejoannah
nanjekyejoannah merged commit d12af71 into python:masterJul 6, 2020
@miss-islington

miss-islington commented Jul 6, 2020

Copy link
Copy Markdown
Contributor

Thanks @nanjekyejoannah 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 6, 2020
@nanjekyejoannah@miss-islington
bpo-28681: Clarify multiple function names in the tutorial (pythonGH-…
aafa60e
…21340)
* improve control flow docs
* Add also
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
(cherry picked from commit d12af71)
Co-authored-by: Joannah Nanjekye <33177550+nanjekyejoannah@users.noreply.github.com>
@bedevere-bot

bedevere-bot commented Jul 6, 2020

Copy link
Copy Markdown

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

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jul 6, 2020
@nanjekyejoannah@miss-islington
bpo-28681: Clarify multiple function names in the tutorial (pythonGH-…
715fb11
…21340)
* improve control flow docs
* Add also
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
(cherry picked from commit d12af71)
Co-authored-by: Joannah Nanjekye <33177550+nanjekyejoannah@users.noreply.github.com>
@nanjekyejoannah

nanjekyejoannah commented Jul 6, 2020

Copy link
Copy Markdown
ContributorAuthor

Thanks for the review @terryjreedy

@bedevere-bot

bedevere-bot commented Jul 6, 2020

Copy link
Copy Markdown

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

nanjekyejoannah added a commit that referenced this pull request Jul 6, 2020
@miss-islington@nanjekyejoannah
bpo-28681: Clarify multiple function names in the tutorial (GH-21340) (…
00c09f0
…GH-21343)
* improve control flow docs
* Add also
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
(cherry picked from commit d12af71)
Co-authored-by: Joannah Nanjekye <33177550+nanjekyejoannah@users.noreply.github.com>
Co-authored-by: Joannah Nanjekye <33177550+nanjekyejoannah@users.noreply.github.com>
nanjekyejoannah added a commit that referenced this pull request Jul 6, 2020
@miss-islington@nanjekyejoannah
bpo-28681: Clarify multiple function names in the tutorial (GH-21340) (…
6790f9b
…GH-21344)
* improve control flow docs
* Add also
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
(cherry picked from commit d12af71)
Co-authored-by: Joannah Nanjekye <33177550+nanjekyejoannah@users.noreply.github.com>
Co-authored-by: Joannah Nanjekye <33177550+nanjekyejoannah@users.noreply.github.com>
shihai1991 pushed a commit to shihai1991/cpython that referenced this pull request Jul 6, 2020
@nanjekyejoannah@terryjreedy@shihai1991
bpo-28681: Clarify multiple function names in the tutorial (pythonGH-…
f3ebc64
…21340)
* improve control flow docs
* Add also
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@terryjreedyterryjreedyterryjreedy approved these changes

Assignees

No one assigned

Labels

docsDocumentation in the Doc dirskip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@nanjekyejoannah@bedevere-bot@terryjreedy@miss-islington@the-knights-who-say-ni