Skip to content

Commit 7902258

Browse files
committed
Fix small doc issues
1 parent a2c7682 commit 7902258

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

src/roslibpy/core.py

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -542,7 +542,7 @@ class ActionClient(object):
542542
Args:
543543
ros (:class:`.Ros`): Instance of the ROS connection.
544544
name (:obj:`str`): Service name, e.g. ``/fibonacci``.
545-
action_type (:obj:`str`): Action type, e.g. ``rospy_tutorials/fibonacci``.
545+
action_type (:obj:`str`): Action type, e.g. ``example_interfaces/action/Fibonacci``.
546546
"""
547547

548548
def __init__(self, ros, name, action_type, reconnect_on_close=True):
@@ -555,18 +555,17 @@ def __init__(self, ros, name, action_type, reconnect_on_close=True):
555555
self.reconnect_on_close = reconnect_on_close
556556

557557
def send_goal(self, goal, resultback, feedback, errback):
558-
""" Start a service call.
558+
"""Start a call to an action.
559559
560-
Note:
561-
The action client is non-blocking.
560+
Note: The action client is non-blocking.
562561
563-
Args:
562+
Args:
564563
request (:class:`.ServiceRequest`): Service request.
565564
resultback: Callback invoked on receiving action result.
566565
feedback: Callback invoked on receiving action feedback.
567566
errback: Callback invoked on error.
568567
569-
Returns:
568+
Returns:
570569
object: goal ID if successfull, otherwise ``None``.
571570
"""
572571
if self._is_advertised:
@@ -589,11 +588,12 @@ def send_goal(self, goal, resultback, feedback, errback):
589588
return action_goal_id
590589

591590
def cancel_goal(self, goal_id):
592-
""" Cancel an ongoing action.
593-
NOTE: Async cancelation is not yet supported on rosbridge (rosbridge_suite issue #909)
591+
"""Cancel an ongoing action.
592+
593+
NOTE: Async cancelation is not yet supported on rosbridge (rosbridge_suite issue #909)
594594
595-
Args:
596-
goal_id: Goal ID returned from "send_goal()"
595+
Args:
596+
goal_id: Goal ID returned from ``send_goal()``
597597
"""
598598
message = Message(
599599
{

0 commit comments

Comments
 (0)