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

Improve API/lifecycle docs #2081

Merged
merged 7 commits into from
Mar 1, 2025
Merged

Improve API/lifecycle docs #2081

merged 7 commits into from
Mar 1, 2025

Conversation

christophfroehlich
Copy link
Contributor

The doxygen docstring of the interfaces classes was broken (see here).

  • I fixed the syntax
  • Removed wrong (never implemented) behavior description
  • Added a lifecycle section in the sphinx docs

image

@christophfroehlich christophfroehlich added the backport-humble This label should be used by maintainers only! Label triggers PR backport to ROS2 humble. label Feb 28, 2025
Copy link

codecov bot commented Feb 28, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.54%. Comparing base (3839200) to head (cf730d0).
Report is 1 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #2081      +/-   ##
==========================================
+ Coverage   89.49%   89.54%   +0.05%     
==========================================
  Files         139      139              
  Lines       15126    15124       -2     
  Branches     1283     1283              
==========================================
+ Hits        13537    13543       +6     
+ Misses       1100     1095       -5     
+ Partials      489      486       -3     
Flag Coverage Δ
unittests 89.54% <ø> (+0.05%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines Coverage Δ
.../include/hardware_interface/actuator_interface.hpp 95.71% <ø> (ø)
...ce/include/hardware_interface/sensor_interface.hpp 96.20% <ø> (+4.95%) ⬆️
...ce/include/hardware_interface/system_interface.hpp 86.87% <ø> (ø)

... and 1 file with indirect coverage changes

Copy link
Member

@saikishor saikishor left a comment

Choose a reason for hiding this comment

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

LGTM

@saikishor
Copy link
Member

Thanks for the changes

@christophfroehlich christophfroehlich merged commit 4f0f300 into master Mar 1, 2025
26 of 27 checks passed
@christophfroehlich christophfroehlich deleted the improve/api/docs branch March 1, 2025 16:21
mergify bot pushed a commit that referenced this pull request Mar 1, 2025
(cherry picked from commit 4f0f300)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-humble This label should be used by maintainers only! Label triggers PR backport to ROS2 humble.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants