🔄 Add naming conventions for forces and torques in style guide #3703
Conversation
This file contains hidden or 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
There was a problem hiding this comment.
Pull Request Overview
This PR enhances the development standards by specifying naming prefixes for physical quantities.
- Introduces a “Forces” section recommending the
for_prefix. - Introduces a “Torques” section recommending the
torq_prefix.
Comments suppressed due to low confidence (1)
documentation/proc-pages/development/standards.md:383
- Add a trailing period to this bullet so it matches the formatting of the Forces section and maintains consistency.
- Torques should start with the `torq_` prefix
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #3703 +/- ##
==========================================
- Coverage 37.82% 36.57% -1.26%
==========================================
Files 88 88
Lines 22696 23650 +954
==========================================
+ Hits 8584 8649 +65
- Misses 14112 15001 +889 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
5e76186 to
49ba9ba
Compare
j-a-foster
approved these changes
Jul 2, 2025
OceanNuclear
pushed a commit
that referenced
this pull request
Jul 12, 2025
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 pull request updates the
standards.mddocumentation to include naming conventions for forces and torques. These additions provide clarity on the prefixes to use for these physical quantities.Documentation updates:
documentation/proc-pages/development/standards.md: Added a section specifying that forces should use thefor_prefix and torques should use thetorq_prefix.Checklist
I confirm that I have completed the following checks: