Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Standardize Doxygen parameter formatting for systems O-Z #2212

Merged
merged 7 commits into from
Nov 8, 2023

Conversation

mabelzhang
Copy link
Contributor

@mabelzhang mabelzhang commented Oct 17, 2023

🦟 Bug fix

Follow up to #2183
Fixes the rest of the alphabet.

Summary

See #2183

Checklist

  • Signed all commits for DCO
  • Added tests
  • Updated documentation (as needed)
  • Updated migration guide (as needed)
  • Consider updating Python bindings (if the library has them)
  • codecheck passed (See contributing)
  • All tests passed (See test coverage)
  • While waiting for a review on your PR, please help review another open pull request to support the maintainers

Note to maintainers: Remember to use Squash-Merge and edit the commit message to match the pull request summary while retaining Signed-off-by messages.

@github-actions github-actions bot added the 🎵 harmonic Gazebo Harmonic label Oct 17, 2023
Signed-off-by: Mabel Zhang <[email protected]>
@mabelzhang mabelzhang added the documentation Improvements or additions to documentation label Oct 18, 2023
Copy link
Contributor

@ahcorde ahcorde left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

linters are failing

fix lint

Signed-off-by: Mabel Zhang <[email protected]>
@codecov
Copy link

codecov bot commented Oct 28, 2023

Codecov Report

Merging #2212 (7e8e501) into gz-sim8 (ac26d9c) will increase coverage by 0.01%.
The diff coverage is n/a.

❗ Current head 7e8e501 differs from pull request most recent head 67c8449. Consider uploading reports for the commit 67c8449 to get more accurate results

@@             Coverage Diff             @@
##           gz-sim8    #2212      +/-   ##
===========================================
+ Coverage    65.66%   65.68%   +0.01%     
===========================================
  Files          324      324              
  Lines        30944    30944              
===========================================
+ Hits         20319    20325       +6     
+ Misses       10625    10619       -6     
Files Coverage Δ
...rc/systems/odometry_publisher/OdometryPublisher.hh 100.00% <ø> (ø)
...rc/systems/performer_detector/PerformerDetector.hh 100.00% <ø> (ø)
src/systems/rf_comms/RFComms.hh 100.00% <ø> (ø)
src/systems/touch_plugin/TouchPlugin.hh 100.00% <ø> (ø)
.../systems/triggered_publisher/TriggeredPublisher.hh 100.00% <ø> (ø)
src/systems/velocity_control/VelocityControl.hh 100.00% <ø> (ø)
src/systems/wheel_slip/WheelSlip.hh 100.00% <ø> (ø)

... and 1 file with indirect coverage changes

Signed-off-by: Mabel Zhang <[email protected]>
…ebosim/gz-sim into mabelzhang/system_docs_format_o_to_z
@mabelzhang
Copy link
Contributor Author

@osrf-jenkins run tests please

@azeey
Copy link
Contributor

azeey commented Nov 7, 2023

@mabelzhang could you fix the compiler warnings on BuoyancyEngine.hh?

@mabelzhang
Copy link
Contributor Author

Got distracted. Let's see the new CI...

Copy link
Contributor

@azeey azeey left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM with green CI

@mabelzhang
Copy link
Contributor Author

CI is good. (The warnings are the same as those in other PRs.)

@mabelzhang mabelzhang merged commit fdbda58 into gz-sim8 Nov 8, 2023
8 of 9 checks passed
@mabelzhang mabelzhang deleted the mabelzhang/system_docs_format_o_to_z branch November 8, 2023 00:50
@azeey
Copy link
Contributor

azeey commented Nov 8, 2023

It would be great if we can backport this to gz-sim7

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation 🎵 harmonic Gazebo Harmonic
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants