chore(docs): Remove positional language + fix style nits #2045
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
|
@ansgarm and @DanielMSchmidt - could we also get this on latest once you approve? I'd like it to be fixed for users :) We can do that by also pushing this to |
DanielMSchmidt
approved these changes
Aug 23, 2022
Merged
|
I'm going to lock this pull request because it has been closed for 30 days. This helps our maintainers find and focus on the active issues. If you've found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
We should not use positional language (above, below, etc.) in our documentation. This is something we did frequently early on, but that we should fix now for consistency with other documentation. This PR removes positional language and fixes a few other tiny style nits (like passive voice) that I found along the way.
The preferred way to introduce code examples is:
"The following example..."
This is good as long as the code immediately follows this explanatory sentence. We should do this in the future instead of saying "the example below."