Skip to content

Small text fixes for enum.rst #27322

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

Merged
merged 2 commits into from
Jul 26, 2021
Merged

Small text fixes for enum.rst #27322

merged 2 commits into from
Jul 26, 2021

Conversation

elliotwaite
Copy link
Contributor

Some suggestions I thought of while reading over this helpful HOWTO.

If any of these changes are incorrect or unwanted, feel free to edit this PR or cherry-pick only the changes you want to keep.

Some suggestions I thought of while reading over this helpful HOWTO.

If any of these changes are incorrect or unwanted, let me know and I can update this PR, or feel free to cherry-pick only the changes you want to keep.
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.

I made a couple changes to your changes, but overall it looks good! Thank you!

@elliotwaite
Copy link
Contributor Author

elliotwaite commented Jul 24, 2021

Thanks for the review. Your changes look good.

That "whitespace or comma separated string" sentence is a tricky one because the value can be a whitespace-separated, comma-separated, or comma-and-whitespace-separated string. Listing all those options might be the clearest, but might be overly verbose given that the code example shown right after that sentence clears up the ambiguity. I see now how what I suggested actually made it worse since it suggested that the value could be a whitespace string or a comma-separated string. From looking at some Google search results, it looks like how you have it now or how you had it before are two popular ways to write that sentence if just deciding on hyphen placement.

@ambv
Copy link
Contributor

ambv commented Jul 26, 2021

At least as a non-native speaker, I prefer "whitespace- and comma-separated" because it clearly builds the sentence structure, making it easier to parse. Listing the whitespace+commas option feels a little verbose to me in this context. I think the current state is clear and reads well.

@ambv ambv merged commit 3e5b82e into python:main Jul 26, 2021
@bedevere-bot
Copy link

@ambv: Please replace # with GH- in the commit message next time. Thanks!

@elliotwaite
Copy link
Contributor Author

@ambv, got it, sounds good. Thanks for the merge.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir skip issue skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants