Fix inaccurate documentation of parseAndRun.

lsst · Jul 30, 2019 · b2033c7 · b2033c7
1 parent 0ee56d7
commit b2033c7
Showing 1 changed file with 3 additions and 2 deletions.
diff --git a/python/lsst/pipe/base/cmdLineTask.py b/python/lsst/pipe/base/cmdLineTask.py
@@ -573,8 +573,9 @@ def parseAndRun(cls, args=None, config=None, log=None, doReturnResults=False):
               `lsst.pipe.base.ArgumentParser.parse_args` method.
             - ``taskRunner``: the task runner used to run the task (an instance of `Task.RunnerClass`).
             - ``resultList``: results returned by the task runner's ``run`` method, one entry per invocation.
-                This will typically be a list of `None` unless ``doReturnResults`` is `True`;
-                see `Task.RunnerClass` (`TaskRunner` by default) for more information.
+                This will typically be a list of `Struct` containing at least an
+                ``exitStatus`` member; see `Task.RunnerClass` (`TaskRunner` by
+                default) for more information.
 
         Notes
         -----