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 (backport #2081) #2085

Open
wants to merge 1 commit into
base: humble
Choose a base branch
from

Conversation

mergify[bot]
Copy link
Contributor

@mergify mergify bot commented Mar 1, 2025

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


This is an automatic backport of pull request #2081 done by [Mergify](https://mergify.com).

(cherry picked from commit 4f0f300)
Copy link

codecov bot commented Mar 1, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 62.67%. Comparing base (dff1474) to head (4e12e54).
Report is 3 commits behind head on humble.

Additional details and impacted files
@@           Coverage Diff           @@
##           humble    #2085   +/-   ##
=======================================
  Coverage   62.67%   62.67%           
=======================================
  Files         109      109           
  Lines       12641    12641           
  Branches     8583     8583           
=======================================
  Hits         7923     7923           
  Misses        902      902           
  Partials     3816     3816           
Flag Coverage Δ
unittests 62.67% <ø> (ø)

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 100.00% <ø> (ø)
...ce/include/hardware_interface/sensor_interface.hpp 100.00% <ø> (ø)
...ce/include/hardware_interface/system_interface.hpp 100.00% <ø> (ø)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant