Add missing in pysmurf-controller docstrings (#553)

socs/agents/pysmurf_controller/agent.py

@@ -265,7 +265,7 @@ def abort(self, session, params=None):
     @ocs_agent.param('poll_interval', type=float, default=10)
     @ocs_agent.param('test_mode', default=False, type=bool)
     def check_state(self, session, params=None):
-        """check_state(poll_interval=10)
+        """check_state(poll_interval=10, test_mode=False)
 
         **Process** - Continuously checks the current state of the smurf. This
         will not modify the smurf state, so this task can be run in conjunction
@@ -276,6 +276,9 @@ def check_state(self, session, params=None):
         -----
         poll_interval : float
             Time (sec) between updates.
+        test_mode : bool, optional
+            Run the Process loop only once. This is meant only for testing.
+            Default is False.
 
         Notes
         -------
@@ -336,7 +339,8 @@ def _stop_check_state(self, session, params):
     @ocs_agent.param('tag', default=None)
     @ocs_agent.param('test_mode', default=False, type=bool)
     def stream(self, session, params):
-        """stream(duration=None)
+        """stream(duration=None, kwargs=None, load_tune=True, \
+                  stream_type='obs', subtype=None, tag=None, test_mode=False)
 
         **Process** - Stream smurf data. If a duration is specified, stream
         will end after that amount of time. If unspecified, the stream will run
@@ -362,6 +366,9 @@ def stream(self, session, params):
         tag : string, optional
             Tag (or comma-separated list of tags) to attach to the G3 stream.
             This has precedence over the `tag` key in the kwargs dict.
+        test_mode : bool, optional
+            Run the Process loop only once. This is meant only for testing.
+            Default is False.
 
         Notes
         ------
@@ -554,7 +561,7 @@ def uxm_relock(self, session, params):
     @ocs_agent.param('kwargs', default=None)
     @ocs_agent.param('tag', default=None)
     def take_noise(self, session, params):
-        """take_noise(duration=30., kwargs=None)
+        """take_noise(duration=30., kwargs=None, tag=None)
 
         **Task** - Takes a short timestream and calculates noise statistics.
         Median white noise level for each band will be stored in the session
@@ -604,7 +611,7 @@ def take_noise(self, session, params):
     @ocs_agent.param('kwargs', default=None)
     @ocs_agent.param('tag', default=None)
     def take_bgmap(self, session, params):
-        """take_bgmap(kwargs=None)
+        """take_bgmap(kwargs=None, tag=None)
 
         **Task** - Takes a bias-group map. This will calculate the number of
         channels assigned to each bias group and put that into the session data
@@ -666,7 +673,7 @@ def take_bgmap(self, session, params):
     @ocs_agent.param('kwargs', default=None)
     @ocs_agent.param('tag', default=None)
     def take_iv(self, session, params):
-        """take_iv(kwargs=None)
+        """take_iv(kwargs=None, tag=None)
 
         **Task** - Takes an IV. This will add the normal resistance array and
         channel info to the session data object along with the analyzed IV
@@ -722,7 +729,7 @@ def take_iv(self, session, params):
     @ocs_agent.param('rfrac_range', default=(0.2, 0.9))
     @ocs_agent.param('tag', default=None)
     def take_bias_steps(self, session, params):
-        """take_bias_steps(kwargs=None, rfrac_range=(0.2, 0.9))
+        """take_bias_steps(kwargs=None, rfrac_range=(0.2, 0.9), tag=None)
 
         **Task** - Takes bias_steps and saves the output filepath to the
         session data object. See the `sodetlib bias step docs page