Tweak opening "important note" in installing-packages tutorial #810
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
This flips the order of "synonym" vs "meaning", to convey the meaning before using a loaded term that'll link to the glossary. This should help make it less intimidating to first-time readers as well as generally make it easier to follow the sentence.
Member
Author
|
Quick link to rich diff, for potential reviewers: https://github.com/pypa/packaging.python.org/pull/810/files?short_path=2cf5869#diff-2cf586919b869d30eb978eb3877500e2d3a6b7e1feb0e03605bb2e25b490c2a1 |
Member
Author
|
Merging based on a self-review -- I had a day in-between, so it's fine. :P |
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.
This flips the order of "synonym" vs "meaning", to convey the meaning before using
a loaded term that'll link to the glossary. This should help make it less intimidating to
first-time readers as well as generally make it easier to follow the sentence.
PS: It's likely easier to review this PR in "rich diff" mode, since I've had to re-wrap the entire passage.