Docs: Add MD for var-naming #2594
Merged
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
ssbarnea
approved these changes
Oct 11, 2022
oraNod
force-pushed
the
rule-docs-var-naming
branch
2 times, most recently
from
94deb56
to
aed297f
Compare
ssbarnea
reviewed
Oct 11, 2022
| this_is_valid: # <- This is a dict, not a variable | ||
| ALL_CAPS: bar # <- Contains only uppercase characters. | ||
| v@r!able: baz # <- Contains special characters. | ||
| ``` |
There was a problem hiding this comment.
That is not correct because variables are only the keys at the first level under vars. They can have any kind of value and if they are dictionaries the keys of these dictionaries are not forced to follow the same rules. Basically only the CameCase example is correct.
There was a problem hiding this comment.
How about now? I just remove the dictionary to avoid confusion.
oraNod
force-pushed
the
rule-docs-var-naming
branch
from
aed297f
to
be115ee
Compare
ssbarnea
approved these changes
Oct 11, 2022
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 PR adds docu for the var-naming rule.