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.

Sign up for GitHub

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

Fix docstring for Servo smoothHalt function (backport #3298) #3308

Merged
merged 1 commit into from
Feb 4, 2025
Merged

Fix docstring for Servo smoothHalt function (backport #3298) #3308

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions moveit_ros/moveit_servo/include/moveit_servo/servo.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,7 @@ class Servo

/**
* \brief Returns the most recent servo parameters.
* @return The servo parameters.
*/
servo::Params& getParams();

Expand All @@ -126,8 +127,9 @@ class Servo

/**
* \brief Smoothly halt at a commanded state when command goes stale.
* @param halt_state The desired stop state.
* @return The next state stepping towards the required halting state.
* @param halt_state The desired halting state.
* @return A pair where the first element is a Boolean indicating whether the robot has stopped, and the second is a
* state stepping towards the desired halting state.
*/
std::pair<bool, KinematicState> smoothHalt(const KinematicState& halt_state);

Expand Down
Loading