Fix steering controllers library code documentation and naming (backport #1149) #1165
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
![mergify[bot]](https://avatars.githubusercontent.com/in/10562?s=60&v=4){kind=small}
* Update documentation and consolidate variable names * Simplify private methods and further update docs * Rename methods * Rename method and variables * Rename convert method * Rename variables and improve doc * Rename local variables * Use std::isfinite instead of !isnan Co-authored-by: Sai Kishor Kothakota <sai.kishor@pal-robotics.com> * Use a lowercase theta for heading Co-authored-by: Sai Kishor Kothakota <sai.kishor@pal-robotics.com> * Make some temporary variables const * Let update_from_position call update_from_velocity * Explicitly set variables with 0 in constructor * Fix docstring * Apply consistent variable naming Co-authored-by: Quique Llorente <ellorent@redhat.com> --------- Co-authored-by: Sai Kishor Kothakota <sai.kishor@pal-robotics.com> Co-authored-by: Quique Llorente <ellorent@redhat.com> (cherry picked from commit b245155)
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## iron #1165 +/- ##
==========================================
+ Coverage 86.67% 86.92% +0.25%
==========================================
Files 86 86
Lines 7412 7401 -11
Branches 612 611 -1
==========================================
+ Hits 6424 6433 +9
+ Misses 759 740 -19
+ Partials 229 228 -1
Flags with carried forward coverage won't be shown. Click here to find out more.
|
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.
A follow-up to #1118, using consistent nomenclature introduced in #954
My commits do not change any logic or behavior, just make the code more readable.
This is an automatic backport of pull request #1149 done by Mergify.