Skip to content

Commit bddab3f

Browse files
authored
Fix trajectory execution manager comments for docs builds (#2563)
1 parent 2598b23 commit bddab3f

File tree

2 files changed

+15
-15
lines changed

2 files changed

+15
-15
lines changed

moveit_py/src/moveit/moveit_ros/trajectory_execution_manager/trajectory_execution_manager.cpp

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ void initTrajectoryExecutionManager(py::module& m)
6464
R"(
6565
Make sure the active controllers are such that trajectories that actuate joints in the specified group can be executed.
6666
67-
If manage_controllers_ is false and the controllers that happen to be active do not cover the joints in the group to be actuated, this function fails.
67+
If the 'moveit_manage_controllers' parameter is false and the controllers that happen to be active do not cover the joints in the group to be actuated, this function fails.
6868
)")
6969

7070
.def("ensure_active_controllers_for_joints",
@@ -73,23 +73,23 @@ void initTrajectoryExecutionManager(py::module& m)
7373
R"(
7474
Make sure the active controllers are such that trajectories that actuate joints in the specified set can be executed.
7575
76-
If manage_controllers_ is false and the controllers that happen to be active do not cover the joints to be actuated, this function fails.
76+
If the 'moveit_manage_controllers' parameter is false and the controllers that happen to be active do not cover the joints to be actuated, this function fails.
7777
)")
7878

7979
.def("ensure_active_controller",
8080
&trajectory_execution_manager::TrajectoryExecutionManager::ensureActiveController, py::arg("controller"),
8181
R"(
8282
Make sure a particular controller is active.
8383
84-
If manage_controllers_ is false and the controllers that happen to be active to not include the one specified as argument, this function fails.
84+
If the 'moveit_manage_controllers' parameter is false and the controllers that happen to be active do not include the one specified as argument, this function fails.
8585
)")
8686

8787
.def("ensure_active_controllers",
8888
&trajectory_execution_manager::TrajectoryExecutionManager::ensureActiveControllers, py::arg("controllers"),
8989
R"(
9090
Make sure a particular set of controllers are active.
9191
92-
If manage_controllers_ is false and the controllers that happen to be active to not include the ones specified as argument, this function fails.
92+
If the 'moveit_manage_controllers' parameter is false and the controllers that happen to be active do not include the ones specified as argument, this function fails.
9393
)")
9494

9595
.def("is_controller_active", &trajectory_execution_manager::TrajectoryExecutionManager::isControllerActive,
@@ -101,7 +101,7 @@ void initTrajectoryExecutionManager(py::module& m)
101101
.def("are_controllers_active", &trajectory_execution_manager::TrajectoryExecutionManager::areControllersActive,
102102
py::arg("controllers"),
103103
R"(
104-
Check if a set of controllers are active
104+
Check if a set of controllers is active.
105105
)")
106106

107107
.def("push",

moveit_ros/planning/trajectory_execution_manager/include/moveit/trajectory_execution_manager/trajectory_execution_manager.h

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -105,30 +105,30 @@ class MOVEIT_TRAJECTORY_EXECUTION_MANAGER_EXPORT TrajectoryExecutionManager
105105

106106
/** \brief Make sure the active controllers are such that trajectories that actuate joints in the specified group can
107107
be executed.
108-
\note If manage_controllers_ is false and the controllers that happen to be active do not cover the joints in the
109-
group to be actuated, this function fails. */
108+
\note If the 'moveit_manage_controllers' parameter is false and the controllers that happen to be active do not
109+
cover the joints in the group to be actuated, this function fails. */
110110
bool ensureActiveControllersForGroup(const std::string& group);
111111

112112
/** \brief Make sure the active controllers are such that trajectories that actuate joints in the specified set can be
113113
executed.
114-
\note If manage_controllers_ is false and the controllers that happen to be active do not cover the joints to be
115-
actuated, this function fails. */
114+
\note If the 'moveit_manage_controllers' parameter is false and the controllers that happen to be active do not
115+
cover the joints to be actuated, this function fails. */
116116
bool ensureActiveControllersForJoints(const std::vector<std::string>& joints);
117117

118118
/** \brief Make sure a particular controller is active.
119-
\note If manage_controllers_ is false and the controllers that happen to be active to not include the one
120-
specified as argument, this function fails. */
119+
\note If the 'moveit_manage_controllers' parameter is false and the controllers that happen to be active do not
120+
include the one specified as argument, this function fails. */
121121
bool ensureActiveController(const std::string& controller);
122122

123123
/** \brief Make sure a particular set of controllers are active.
124-
\note If manage_controllers_ is false and the controllers that happen to be active to not include the ones
125-
specified as argument, this function fails. */
124+
\note If the 'moveit_manage_controllers' parameter is false and the controllers that happen to be active do not
125+
include the ones specified as argument, this function fails. */
126126
bool ensureActiveControllers(const std::vector<std::string>& controllers);
127127

128-
/** \brief Check if a controller is active */
128+
/** \brief Check if a controller is active. */
129129
bool isControllerActive(const std::string& controller);
130130

131-
/** \brief Check if a set of controllers are active */
131+
/** \brief Check if a set of controllers is active. */
132132
bool areControllersActive(const std::vector<std::string>& controllers);
133133

134134
/// Add a trajectory for future execution. Optionally specify a controller to use for the trajectory. If no controller

0 commit comments

Comments
 (0)