[documentation] Edits to whatis.rst #257
Closed
Conversation
This file contains 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
I cleaned up language in the document page whatis.rst. In several places the language was vague, hard to follow, or inconsistently styled. I did my best to correct these.
Adjusted wording for first paragraph
Reworked the wording of the fourth paragraph, which lists possible interfaces.
Last change wasn't as final as I thought. My apologies on the odd git workflow, it will take me a minute to get used to this.
|
I appreciate the initiative with this, but looking through the PR, there's a few extra typos and mistakes that are actually introduced into the text. I'm in a bit of pinch time-wise right now, and I can't go through them individually, so I'll have to close this PR for now. Thanks anyways! |
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.
The following edits are my attempt at simplifying and clarifying the whatis.rst file as much as possible.
They are mostly changes in form, not content. See my documentation overhaul discussion #256
Areas that need updates
This is where content changes may need to occur:
-- Could use a guide linked into the fourth paragraph.