fixed inconsistency in documentation

2018-11-19 14:58:03 +01:00
parent 1e826311c8
commit c6cce7e2ce
1 changed files with 2 additions and 5 deletions
--- a/pykick/striker.py
+++ b/pykick/striker.py
@@ -276,6 +276,8 @@ class Striker(object):
        Call this until this returns True - then the robot is facing
        the ball.

+        This will block until the robot sees the ball and is facing the ball.
+
        Parameters
        ----------
        soll : float
@@ -285,11 +287,6 @@ class Striker(object):
        tol : float
            Allowable deviation in radians from soll-angle.

-        Returns
-        -------
-        bool
-            True if robot is nicely aligned to ball; else False.
-
        """

        ball_locked = False