Merge pull request #1031 from tue-robotics/small_fixes_docs

(robot_skills) small doc fixes

robot_skills/src/robot_skills/amigo.py

@@ -1,11 +1,21 @@
+from __future__ import print_function
+
 from robot_skills import robot, api, arms, base, ebutton, head, ears, lights, perception, speech, \
     sound_source_localisation, torso, world_model_ed
 from .simulation import is_sim_mode, SimEButton
 
 
 class Amigo(robot.Robot):
-    """docstring for Amigo"""
+    """
+    Amigo
+    """
     def __init__(self, dontInclude=None, wait_services=False):
+        """
+        Constructor
+
+        :param dontInclude: Not supported anymore
+        :param wait_services: Not supported anymore by robot class
+        """
         if dontInclude is None:
             dontInclude = []
         super(Amigo, self).__init__(robot_name="amigo", wait_services=wait_services)

robot_skills/src/robot_skills/hero.py

@@ -4,9 +4,15 @@
 import rospy
 import math
 
+
 class Hero(robot.Robot):
-    """docstring for Hero"""
+    """Hero"""
     def __init__(self, wait_services=False):
+        """
+        Constructor
+
+        :param wait_services: Not supported anymore by robot class
+        """
         super(Hero, self).__init__(robot_name="hero", wait_services=wait_services)
 
         self._ignored_parts = ["leftArm", "torso", "spindle", "head"]

robot_skills/src/robot_skills/robot.py

@@ -22,6 +22,19 @@ class Robot(object):
     Interface to all parts of the robot.
     """
     def __init__(self, robot_name="", wait_services=False, tf_listener=None):
+        """
+        Constructor
+
+        :param robot_name: Name of the robot
+        :type robot_name: str
+        :param wait_services: Not used anymore
+        :type wait_services: bool
+        :param tf_listener: tf_listener object
+        :type tf_listener: Optional[tf.TransformListener]
+        """
+
+        if wait_services:
+            rospy.logwarn("(Robot) wait_services is not used anymore and will be removed in the future")
 
         self.robot_name = robot_name
         self.tf_listener = tf.TransformListener() if tf_listener is None else tf_listener

robot_skills/src/robot_skills/sergio.py

@@ -4,8 +4,15 @@
 
 
 class Sergio(robot.Robot):
-    """docstring for Sergio"""
+    """
+    Sergio
+    """
     def __init__(self, wait_services=False):
+        """
+        Constructor
+
+        :param wait_services: Not supported anymore by robot class
+        """
         super(Sergio, self).__init__(robot_name="sergio", wait_services=wait_services)
 
         self._ignored_parts = ["leftArm", "rightArm", "torso", "spindle", "head"]

robot_skills/src/robot_skills/world_model_ed.py

@@ -77,7 +77,8 @@ def __init__(self, robot_name, tf_listener):
         self.robot_name = robot_name
 
     def wait_for_connections(self, timeout, log_failing_connections=True):
-        """ Waits for the connections until they are connected
+        """
+        Waits for the connections until they are connected
 
         :param timeout: timeout in seconds
         :param log_failing_connections: (bool) whether to log errors if not connected. This is useful when checking