Skip to content

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

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 2 commits into from
Jul 6, 2020
Merged

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

merged 2 commits into from
Jul 6, 2020

Conversation

nanjekyejoannah
Copy link
Contributor

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

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

https://bugs.python.org/issue28681

@bedevere-bot bedevere-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
Copy link
Member

@terryjreedy terryjreedy left a comment •
edited
Loading

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.

@bedevere-bot
Copy link

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>
@terryjreedy terryjreedy changed the title bpo-28681: About function renaming in the tutorial bpo-28681: Clarify multiple function names in the tutorial Jul 6, 2020
@terryjreedy
Copy link
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.

@terryjreedy terryjreedy mentioned this pull request Jul 6, 2020
Merged
@nanjekyejoannah nanjekyejoannah merged commit d12af71 into python:master Jul 6, 2020
@miss-islington
Copy link
Contributor

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

@bedevere-bot
Copy link

GH-21343 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 Jul 6, 2020
@nanjekyejoannah
Copy link
Contributor Author

Thanks for the review @terryjreedy

@bedevere-bot
Copy link

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@terryjreedy terryjreedy terryjreedy approved these changes

Assignees
No one assigned
Labels
docs Documentation in the Doc dir skip 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