DOC: Updating grammar for clarity and consistency #43061
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mroeschke
approved these changes
Aug 16, 2021
|
thanks @andrewwoood |
feefladder
pushed a commit
to feefladder/pandas
that referenced
this pull request
Sep 7, 2021
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.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Location of the documentation
10 minutes to pandas
Documentation problem
Throughout the page, there are code examples with an accompanying explanation of what is happening. The explanation will sometimes end in a colon, and other times end with a period. Here is a screenshot of the inconsistency:
Suggested fix for documentation
I think that having a colon is the correct usage considering that the sentences are explaining the code block underneath it. I also think it would be better for the page to be consistent in punctuation. In my pull request, I've changed all the instances where I think this is applicable, as well as changing a couple of wordings to be easier to understand.