refactor: convert a public string to a property #308
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
It came to my attention that we have violations of the inspection that is responsible for custom rules: IDE1006. After browsing editorconfig, I discovered that we have a couple custom rules. One of them was explained as "Use camel case for local variable". This commit makes sure that any local functions and constants are camelCase. To reiterate, that does not change the code style. It applies already-existing rules.
Use PascalCase properties if there are no camelCase ones around. There is no reason for us to be unconventional by definition regarding properties. If the class uses camelCase properties, then we use camelCase. If the class does not have camelCase properties, then we use PascalCase properties.
That is done to get rid of the warning CA2211 that was previously suppressed for the line where the string was defined.
|
QA: checked the save, change, and load of a pY project. |
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.
Fixed the suppressed CA2211.
Also noticed that I wrote camelCase properties as the rule when they actually are not PascalCase, only because the legacy code uses them. I fixed that by removing this part from the code style.
Essentially, I suggest to use PascalCase properties if the class does not use camelCase ones.
I've also fixed the violations of the inspection IDE1006.