diff --git a/example_11.md b/example_11.md index 8e65b10..1e0228b 100644 --- a/example_11.md +++ b/example_11.md @@ -93,7 +93,7 @@ class PointCloudTransformer: :param self: The self reference. :param msg: The PointCloud message. - :returns new_cloud: PointCloud message. + :returns new_cloud: The transformed PointCloud message. """ while not rospy.is_shutdown(): try: diff --git a/example_12.md b/example_12.md index 137c0c7..b805961 100644 --- a/example_12.md +++ b/example_12.md @@ -144,7 +144,7 @@ class LocateArUcoTag(hm.HelloNode): :param self: The self reference. :param tag_name: A string value of the ArUco marker name. - :returns transform: A TransformStamped message type. + :returns transform: The docking station's TransformStamped message. """ pan_command = {'joint': 'joint_head_pan', 'position': self.min_pan_position} self.send_command(pan_command) @@ -321,7 +321,7 @@ def find_tag(self, tag_name='docking_station'): :param self: The self reference. :param tag_name: A string value of the ArUco marker name. - :returns transform: A TransformStamped message type. + :returns transform: The docking station's TransformStamped message. """ pan_command = {'joint': 'joint_head_pan', 'position': self.min_pan_position} self.send_command(pan_command) diff --git a/example_9.md b/example_9.md index 83d9f64..3f2d0a7 100644 --- a/example_9.md +++ b/example_9.md @@ -98,16 +98,17 @@ class GetVoiceCommands: def callback_direction(self, msg): """ - A callback function that converts the sound direction from degrees to radians. + A callback function that converts the incoming message, sound direction, + from degrees to radians. :param self: The self reference. - :param msg: The Int32 message type. + :param msg: The Int32 message type that represents the sound direction. """ self.sound_direction = msg.data * -self.rad_per_deg def callback_speech(self,msg): """ - A callback function that takes all items in the iterable list and join - them into a single string. + A callback function takes the incoming message, a list of the speech to + text, and joins all items in that iterable list into a single string. :param self: The self reference. :param msg: The SpeechRecognitionCandidates message type. """ @@ -119,7 +120,7 @@ class GetVoiceCommands: base motion. :param self:The self reference. - :returns inc: A dictionary type. + :returns inc: A dictionary type the contains the increment size. """ if self.step_size == 'small': inc = {'rad': self.small_rad, 'translate': self.small_translate} @@ -159,7 +160,7 @@ class GetVoiceCommands: A function that defines the teleoperation command based on the voice command. :param self: The self reference. - :returns command: A dictionary type. + :returns command: A dictionary type that contains the type of base motion. """ command = None if self.voice_command == 'forward': @@ -192,6 +193,7 @@ class VoiceTeleopNode(hm.HelloNode): """ A function that declares object from the GetVoiceCommands class, instantiates the HelloNode class, and set the publishing rate. + :param self: The self reference. """ hm.HelloNode.__init__(self) self.rate = 10.0 diff --git a/src/aruco_tag_locator.py b/src/aruco_tag_locator.py index 5eaa99f..4284512 100755 --- a/src/aruco_tag_locator.py +++ b/src/aruco_tag_locator.py @@ -130,7 +130,7 @@ class LocateArUcoTag(hm.HelloNode): :param self: The self reference. :param tag_name: A string value of the ArUco marker name. - :returns transform: A TransformStamped message type. + :returns transform: The docking station's TransformStamped message. """ # Create dictionaries to get the head in its initial position pan_command = {'joint': 'joint_head_pan', 'position': self.min_pan_position} diff --git a/src/pointcloud_transformer.py b/src/pointcloud_transformer.py index ac41aba..27f5090 100755 --- a/src/pointcloud_transformer.py +++ b/src/pointcloud_transformer.py @@ -74,7 +74,7 @@ class PointCloudTransformer: :param self: The self reference. :param msg: The PointCloud message. - :returns new_cloud: PointCloud message. + :returns new_cloud: The transformed PointCloud message. """ while not rospy.is_shutdown(): try: diff --git a/src/voice_teleoperation_base.py b/src/voice_teleoperation_base.py index ce09b5f..92aca8f 100755 --- a/src/voice_teleoperation_base.py +++ b/src/voice_teleoperation_base.py @@ -69,16 +69,17 @@ class GetVoiceCommands: def callback_direction(self, msg): """ - A callback function that converts the sound direction from degrees to radians. + A callback function that converts the incoming message, sound direction, + from degrees to radians. :param self: The self reference. - :param msg: The Int32 message type. + :param msg: The Int32 message type that represents the sound direction. """ self.sound_direction = msg.data * -self.rad_per_deg def callback_speech(self,msg): """ - A callback function that takes all items in the iterable list and join - them into a single string. + A callback function takes the incoming message, a list of the speech to + text, and joins all items in that iterable list into a single string. :param self: The self reference. :param msg: The SpeechRecognitionCandidates message type. """ @@ -90,7 +91,7 @@ class GetVoiceCommands: base motion. :param self:The self reference. - :returns inc: A dictionary type. + :returns inc: A dictionary type the contains the increment size. """ if self.step_size == 'small': inc = {'rad': self.small_rad, 'translate': self.small_translate} @@ -130,7 +131,7 @@ class GetVoiceCommands: A function that defines the teleoperation command based on the voice command. :param self: The self reference. - :returns command: A dictionary type. + :returns command: A dictionary type that contains the type of base motion. """ command = None # Move base forward command @@ -181,6 +182,7 @@ class VoiceTeleopNode(hm.HelloNode): """ A function that declares object from the GetVoiceCommands class, instantiates the HelloNode class, and set the publishing rate. + :param self: The self reference. """ hm.HelloNode.__init__(self) self.rate = 10.0 @@ -199,7 +201,7 @@ class VoiceTeleopNode(hm.HelloNode): """ Function that makes an action call and sends base joint trajectory goals. :param self: The self reference. - :param command: A dictionary type. + :param command: A dictionary that contains the base motion type and increment size. """ joint_state = self.joint_state # Conditional statement to send joint trajectory goals