Skip to content

Conversation

rishitej04
Copy link
Contributor

This PR improves the documentation comments in
hardware_interface/hardware_component_interface.hpp.

Previously, the getter methods (get_clock(), get_node(),
and get_hardware_info()) referred generically to "the Interface".
This wording was ambiguous, since the file defines
HardwareComponentInterface.

The comments have been updated to explicitly reference
HardwareComponentInterface, making the documentation clearer
and easier for new contributors and users to follow.

No functional changes were made — this is purely a documentation fix.

Copy link
Contributor

@christophfroehlich christophfroehlich left a comment

Choose a reason for hiding this comment

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

FYI: this does not fix #2419, can you do that in the same PR please?

Copy link

codecov bot commented Aug 17, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 89.21%. Comparing base (9281169) to head (639b94c).
⚠️ Report is 2 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #2471   +/-   ##
=======================================
  Coverage   89.21%   89.21%           
=======================================
  Files         144      144           
  Lines       16334    16334           
  Branches     1393     1393           
=======================================
  Hits        14573    14573           
  Misses       1225     1225           
  Partials      536      536           
Flag Coverage Δ
unittests 89.21% <ø> (ø)

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

Files with missing lines Coverage Δ
...ardware_interface/hardware_component_interface.hpp 86.09% <ø> (ø)
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@christophfroehlich
Copy link
Contributor

@soham2560 what do you think?

Copy link
Contributor

@soham2560 soham2560 left a comment

Choose a reason for hiding this comment

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

@soham2560 what do you think?

This also works, does make it more clearer and directed towards the class name

Co-authored-by: Sai Kishor Kothakota <[email protected]>
@bmagyar bmagyar merged commit 605718c into ros-controls:master Aug 20, 2025
1 check passed
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.

5 participants