Updating hydrodynamics plugin description #1502
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
Signed-off-by: Dharini Dutia <[email protected]>
Signed-off-by: Dharini Dutia <[email protected]>
|
Not sure if the checklist is applicable here and how to update the documentation |
chapulina
added
🏯 fortress
chapulina
approved these changes
May 19, 2022
chapulina
suggested changes
May 19, 2022
| @@ -41,7 +41,7 @@ namespace systems | |||
| /// plugin), etc. | |||
| /// | |||
| /// # System Parameters | |||
| /// The exact description of these parameters can be found on p. 37 of | |||
| /// The exact description of these parameters can be found on p. 37 and p. 43 of | |||
There was a problem hiding this comment.
Oh, linters are unhappy
/github/workspace/src/systems/hydrodynamics/Hydrodynamics.hh:44: Lines should be <= 80 characters long [whitespace/line_length] [2]
arjo129
reviewed
May 20, 2022
Signed-off-by: Dharini Dutia <[email protected]>
Codecov Report
@@ Coverage Diff @@
## ign-gazebo6 #1502 +/- ##
============================================
Coverage 33.58% 33.58%
============================================
Files 44 44
Lines 2260 2260
============================================
Hits 759 759
Misses 1501 1501 Continue to review full report at Codecov.
|
chapulina
approved these changes
May 23, 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.
Summary
Improved the hydrodynamics plugin parameters description to easily map with Fossen's book notation and understand their significance for usage.
Note to maintainers: Remember to use Squash-Merge and edit the commit message to match the pull request summary while retaining
Signed-off-bymessages.