Improved Readability #128
Open
Improved Readability #128
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
Added Good Practice & Bad Practice instead of Good & Bad.
dingo-d
approved these changes
Jun 14, 2023
jrfnl
reviewed
Jun 14, 2023
There was a problem hiding this comment.
I'm not a fan of this change.
- It makes the page even more inconsistent with the rest of the coding standards pages which mostly use "Correct" and "Incorrect".
- In most cases, these are hard rules and not suggestions, so the phrasing "Good practice"/"Bad practice" does not apply.
Additionally, the punctuation of the adjusted comments does not comply with the docs coding standards.
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.
Added Good Practice & Bad Practice instead of Good & Bad.