ACU sunvoidance: couple more docs fixes

simonsobs · Nov 7, 2023 · e2faba8 · e2faba8
1 parent 330be86
commit e2faba8
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 8 deletions.
diff --git a/socs/agents/acu/agent.py b/socs/agents/acu/agent.py
@@ -2087,7 +2087,8 @@ def _notify_recomputed(result):
     @ocs_agent.param('avoidance_radius', type=float, default=None)
     @ocs_agent.param('shift_sun_hours', type=float, default=None)
     def update_sun(self, session, params):
-        """update_sun(reset, enable, temporary_disable, escape, avoidance_radius, shift_sun_hours)
+        """update_sun(reset, enable, temporary_disable, escape, \
+                      avoidance_radius, shift_sun_hours)
 
         **Task** - Update Sun monitoring and avoidance parameters.
 

diff --git a/socs/agents/acu/avoidance.py b/socs/agents/acu/avoidance.py
@@ -530,13 +530,15 @@ def select_move(self, moves, raw=False):
         If raw=True, a debugging output is returned; see code.
 
         Returns:
-          best_move (dict): The element of moves that is safest.  If
-            no safe move was found, None is returned.
-          decisions (list): The items in this list are dicts that
-            correspond one-to-one with the entries in moves.  Each
-            decision dict has entries 'rejected' (True or False) and
-            'reason' (string description of why the move was rejected
-            outright).
+          (dict, list): (best_move, decisions)
+
+          ``best_move`` -- the element of moves that is safest.  If no
+          safe move was found, None is returned.
+
+          ``decisions`` - List of dicts, in one-to-one correspondence
+          with ``moves``.  Each decision dict has entries 'rejected'
+          (True or False) and 'reason' (string description of why the
+          move was rejected outright).
 
         """
         _p = self.policy