8000 Minor documentation fixes on library/enum by awecx · Pull Request #15234 · python/cpython · GitHub
[go: up one dir, main page]
Skip to content

Minor documentation fixes on library/enum #15234

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
Aug 20, 2019
Merged

Minor documentation fixes on library/enum #15234

merged 4 commits into from
Aug 20, 2019

Conversation

awecx
Copy link
Contributor
@awecx awecx commented Aug 12, 2019 •
edited
Loading

This PR fixes 3 minor issues in library/enum doc:

  • l.386: extra "were" that make the sentence incorrect.
  • l.732: I believe this is a bad example.
  • l.1056 typo: we're referring here to list and str as objects, not callables.

@bedevere-bot bedevere-bot added docs Documentation in the Doc dir awaiting review labels Aug 12, 2019
@tirkarthi
Copy link
Member

cc: @ethanfurman

ethanfurman
ethanfurman requested changes Aug 13, 2019
View reviewed changes
@bedevere-bot
Copy link

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

And if you don't make the requested changes, you will be poked with soft cushions!

@ethanfurman ethanfurman self-assigned this Aug 13, 2019
@awecx
Copy link
Contributor Author
awecx commented Aug 16, 2019

I have made the requested changes; please review again.
As discussed, I've updated the sentence "any value(s) given to the enum member will be passed into those methods" and left the removal of the example in the mixin section.

@bedevere-bot
Copy link

Thanks for making the requested changes!

@ethanfurman: please review the changes made to this pull request.

@ethanfurman
Copy link
Member

@awecx, Is your name in the Misc/ACKS file? If you want it to be, please add that commit as well.

@awecx
Copy link
Contributor Author
awecx commented Aug 16, 2019

@awecx, Is your name in the Misc/ACKS file? If you want it to be, please add that commit as well.

No, it isn't.
I've just added myself with the last commit.

ethanfurman
ethanfurman requested changes Aug 16, 2019
View reviewed changes
Copy link
Member
@ethanfurman ethanfurman left a comment

Choose a reason for hiding this comment

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

Apologies, one more quick change.

@bedevere-bot
Copy link

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

@awecx
Copy link
Contributor Author

I have made the requested changes; please review again.
I've applied your last suggestion.

@bedevere-bot
Copy link

Thanks for making the requested changes!

@ethanfurman: please review the changes made to this pull request.

@ethanfurman ethanfurman merged commit d3c8d73 into python:master Aug 20, 2019
@ethanfurman
Copy link
Member

@awecx - Thank you for your patience and perseverance!

@awecx
Copy link
Contributor Author
awecx commented Aug 20, 2019

@awecx - Thank you for your patience and perseverance!

Thank YOU for advice and review of this (my first!) PR. I really appreciated.

lisroach pushed a commit to lisroach/cpython that referenced this pull request Sep 10, 2019
@awecx @lisroach
Minor documentation fixes on library/enum (pythonGH-15234)
f5d6052 
* Minor documentation fixes on library/enum
DinoV pushed a commit to DinoV/cpython that referenced this pull request Jan 14, 2020
@awecx @DinoV
Minor documentation fixes on library/enum (pythonGH-15234)
2022e1b 
* Minor documentation fixes on library/enum
websurfer5 pushed a commit to websurfer5/cpython that referenced this pull request Jul 20, 2020
@awecx @websurfer5
Minor documentation fixes on library/enum (pythonGH-15234)
da89671 
* Minor documentation fixes on library/enum
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ethanfurman ethanfurman 5BE9 ethanfurman approved these changes

Assignees

@ethanfurman ethanfurman

Labels
docs Documentation in the Doc dir skip issue skip news
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@awecx @tirkarthi @bedevere-bot @ethanfurman @the-knights-who-say-ni
0