use brevity to improve readability #1007
Open
Conversation
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
The guide has become rather difficult to read at places. This is an attempt to improve its readability. I believe you meant
useand notusage(these words mean different things) and I have gone ahead with the suggestion to use the wordusehere. If you indeed meantusage, then I am afraid, that sentence should be reworded.Also, the sentence
This guide is opinionated in a way that is almost, but not quite, entirely unlike Python’s official documentation.is also unnecessarily complicated (the placement of comma makes it even harder to understand). But I will leave it out of this commit.