Add explanation of underscore-separated units in variable names [ci skip] #6470
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
✅ All tests successful. No failed tests found. Additional details and impacted files@@ Coverage Diff @@
## dev-2.x #6470 +/- ##
=============================================
+ Coverage 70.10% 70.18% +0.07%
- Complexity 18209 18305 +96
=============================================
Files 2073 2081 +8
Lines 77318 77184 -134
Branches 7820 7828 +8
=============================================
- Hits 54205 54168 -37
+ Misses 20344 20248 -96
+ Partials 2769 2768 -1 ☔ View full report in Codecov by Sentry. |
leonardehrenfried
changed the title
optionsome
reviewed
Feb 24, 2025
Yes, I considered that too. There was no section there on variables, but I could add one. |
t2gran
reviewed
Mar 6, 2025
| @@ -62,6 +62,12 @@ them. | |||
| | `setStop(Stop stop)` | Set a mutable Stop reference. Avoid if not part of natural lifecycle. Use `initStop(...)` if possible. | | |||
| | `getStop() : Stop` | Old style accessor. Use the shorter form `stop() : Stop`. | | |||
|
|
|||
|
|
|||
| ## Variables | |||
There was a problem hiding this comment.
Suggested change
| ## Variables | |
| ## Units in variable names |
Does "variable names" means "field, parameter and variable names"? That is my understanding of this and if we agree on that then I am OK with just using "variable names" - it is easier to read.
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.
As discussed in a recent meeting, this adds a short explanation of why some variables have underscore-separated units as part of their names, defying standard camelCase.
It seems a little strange to update an already existing decision record, but this is a very minor point and probably less likely to be seen if it were split out into a separate style document.