docs: refactor to improve legibility #2432
Open
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
The use of "not more" with the reverse ordering of the sentence made this difficult to parse. After reversing the order and removing negation, the surrounding paragraphs were updated to match the style.
|
Thanks for the contribution @blottn, I can see what you mean about the original wording. I will take a look at this and see, I'll also have to review the actual functionality to ensure it matches. |
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 use of "not more" with the reverse ordering of the sentence made this difficult to parse. After reversing the order and removing negation, the surrounding paragraphs were updated to match the style.
What issue does this pull request resolve?
None
What changes did you make?
Restructured some paragraphs in the docs
Is there anything that requires more attention while reviewing?
Please validate that this new reordering aligns with the functionality as I have only just begun using this tool.