diff --git a/action_msgs/README.md b/action_msgs/README.md index 4f1243a1..cb10d34c 100644 --- a/action_msgs/README.md +++ b/action_msgs/README.md @@ -2,15 +2,15 @@ This package contains several messages and services useful for ROS 2 actions. More information about actions can be found on its [design article](http://design.ros2.org/articles/actions.html). -For more information about ROS 2 interfaces, see [index.ros2.org](https://index.ros.org/doc/ros2/Concepts/About-ROS-Interfaces/) +For more information about ROS 2 interfaces, see [index.ros2.org](https://index.ros.org/doc/ros2/Concepts/About-ROS-Interfaces/). ## Messages (.msg) -* [GoalInfo](msg/GoalInfo.msg): Goal identifier message, with a goal id and time stamp -* [GoalStatus](msg/GoalStatus.msg): Describes a goal's current state machine status -* [GoalStatusArray](msg/GoalStatusArray.msg): An array of [GoalStatus](msg/GoalStatus.msg) messages +* [GoalInfo](msg/GoalInfo.msg): Goal identifier message, with a goal id and time stamp. +* [GoalStatus](msg/GoalStatus.msg): Describes a goal's current state machine status. +* [GoalStatusArray](msg/GoalStatusArray.msg): An array of [GoalStatus](msg/GoalStatus.msg) messages. ## Services (.srv) -* [CancelGoal](srv/CancelGoal.srv): Cancel Goals either by id and/or timestamp +* [CancelGoal](srv/CancelGoal.srv): Cancel Goals either by id and/or timestamp. ## Quality Declaration This package claims to be in the **Quality Level 4** category, see the [Quality Declaration](QUALITY_DECLARATION.md) for more details. diff --git a/action_msgs/msg/GoalStatus.msg b/action_msgs/msg/GoalStatus.msg index ce198a47..6e84a911 100644 --- a/action_msgs/msg/GoalStatus.msg +++ b/action_msgs/msg/GoalStatus.msg @@ -25,7 +25,7 @@ int8 STATUS_CANCELED = 5 # The goal was terminated by the action server without an external request. int8 STATUS_ABORTED = 6 -# Goal info (contains ID and timestamp) +# Goal info (contains ID and timestamp). GoalInfo goal_info # Action goal state-machine status. diff --git a/composition_interfaces/README.md b/composition_interfaces/README.md index 4b459fb7..c3a2a030 100644 --- a/composition_interfaces/README.md +++ b/composition_interfaces/README.md @@ -7,7 +7,7 @@ For more information about ROS 2 interfaces, see [index.ros2.org](https://index. ## Services (.srv) * [ListNodes](srv/ListNodes.srv): Retrieve a list of running composable nodes, including their names and ids. * [LoadNodes](srv/LoadNode.srv): Load a composable node. -* [UnloadNode](UnloadNode.srv): Unload a specified node by its id. +* [UnloadNode](srv/UnloadNode.srv): Unload a specified node by its id. ## Quality Declaration This package claims to be in the **Quality Level 4** category, see the [Quality Declaration](QUALITY_DECLARATION.md) for more details. diff --git a/composition_interfaces/srv/LoadNode.srv b/composition_interfaces/srv/LoadNode.srv index 97f84cc2..ffd243f3 100644 --- a/composition_interfaces/srv/LoadNode.srv +++ b/composition_interfaces/srv/LoadNode.srv @@ -29,7 +29,7 @@ rcl_interfaces/Parameter[] parameters # key/value arguments that are specific to a type of container process. rcl_interfaces/Parameter[] extra_arguments --- -# True if the node was successfully loaded +# True if the node was successfully loaded. bool success # Human readable error message if success is false, else empty string. diff --git a/lifecycle_msgs/msg/State.msg b/lifecycle_msgs/msg/State.msg index 599310e2..4fd07b14 100644 --- a/lifecycle_msgs/msg/State.msg +++ b/lifecycle_msgs/msg/State.msg @@ -4,7 +4,7 @@ # These are the primary states. State changes can only be requested when the # node is in one of these states. -# Indicates state has not yet been set +# Indicates state has not yet been set. uint8 PRIMARY_STATE_UNKNOWN = 0 # This is the life cycle state the node is in immediately after being @@ -36,22 +36,22 @@ uint8 TRANSITION_STATE_CONFIGURING = 10 uint8 TRANSITION_STATE_CLEANINGUP = 11 # In this transition state the callback onShutdown will be executed to do any -# cleanup necessary before destruction +# cleanup necessary before destruction. uint8 TRANSITION_STATE_SHUTTINGDOWN = 12 # In this transition state the callback onActivate will be executed to do any -# final preparations to start executing +# final preparations to start executing. uint8 TRANSITION_STATE_ACTIVATING = 13 # In this transition state the callback onDeactivate will be executed to do any # cleanup to start executing, and reverse the onActivate changes. uint8 TRANSITION_STATE_DEACTIVATING = 14 -# This transition state is where any error may be cleaned up +# This transition state is where any error may be cleaned up. uint8 TRANSITION_STATE_ERRORPROCESSING = 15 -# The state id value from the above definitions +# The state id value from the above definitions. uint8 id -# A text label of the state +# A text label of the state. string label diff --git a/lifecycle_msgs/srv/ChangeState.srv b/lifecycle_msgs/srv/ChangeState.srv index 2e2ebc24..1bad3d10 100644 --- a/lifecycle_msgs/srv/ChangeState.srv +++ b/lifecycle_msgs/srv/ChangeState.srv @@ -1,5 +1,6 @@ -# The requested transition. This change state service will fail if the -# transition is not possible +# The requested transition. +# +# This change state service will fail if the transition is not possible. Transition transition --- diff --git a/lifecycle_msgs/srv/GetAvailableStates.srv b/lifecycle_msgs/srv/GetAvailableStates.srv index ef156d53..2faa79b0 100644 --- a/lifecycle_msgs/srv/GetAvailableStates.srv +++ b/lifecycle_msgs/srv/GetAvailableStates.srv @@ -1,3 +1,3 @@ --- -# Array of possible states that can be transitioned to +# Array of possible states that can be transitioned to. State[] available_states diff --git a/lifecycle_msgs/srv/GetState.srv b/lifecycle_msgs/srv/GetState.srv index b26777d8..b2569fa6 100644 --- a/lifecycle_msgs/srv/GetState.srv +++ b/lifecycle_msgs/srv/GetState.srv @@ -1,3 +1,3 @@ --- -# The current state-machine state of the node +# The current state-machine state of the node. State current_state diff --git a/rosgraph_msgs/msg/Clock.msg b/rosgraph_msgs/msg/Clock.msg index 13489645..25af0e4d 100644 --- a/rosgraph_msgs/msg/Clock.msg +++ b/rosgraph_msgs/msg/Clock.msg @@ -1,4 +1,4 @@ # This message communicates the current time. # -# For more information, see https://design.ros2.org/articles/clock_and_time.html +# For more information, see https://design.ros2.org/articles/clock_and_time.html. builtin_interfaces/Time clock