Skip to content

Commit

Permalink
Fix up docstring syntax
Browse files Browse the repository at this point in the history
Fixes an unclosed inline literal in TaskRunner and a sub-list issue in
Task.
  • Loading branch information
jonathansick committed Apr 12, 2018
1 parent a695220 commit 0b4002d
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 3 deletions.
6 changes: 3 additions & 3 deletions python/lsst/pipe/base/cmdLineTask.py
Original file line number Diff line number Diff line change
Expand Up @@ -379,11 +379,11 @@ def __call__(self, args):
- ``dataRef``: the provided data reference.
- ``metadata``: task metadata after execution of run.
- ``result``: result returned by task run, or `None` if the task fails.
- ``exitStatus`: 0 if the task completed successfully, 1 otherwise.
- ``exitStatus``: 0 if the task completed successfully, 1 otherwise.
If ``doReturnResults`` is `False` the struct contains:
- ``exitStatus`: 0 if the task completed successfully, 1 otherwise.
- ``exitStatus``: 0 if the task completed successfully, 1 otherwise.
Notes
-----
Expand Down Expand Up @@ -452,7 +452,7 @@ def __call__(self, args):


class ButlerInitializedTaskRunner(TaskRunner):
"""A TaskRunner for `CmdLineTask`\ s that require a ``butler`` keyword argument to be passed to
"""A `TaskRunner` for `CmdLineTask`\ s that require a ``butler`` keyword argument to be passed to
their constructor.
"""

Expand Down
1 change: 1 addition & 0 deletions python/lsst/pipe/base/task.py
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,7 @@ class Task(object):
Iteration, if desired, is performed by a caller of the run method. This is good design and allows
multiprocessing without the run method having to support it directly.
- If ``run`` can persist or unpersist data:
- ``run`` should accept a butler data reference (or a collection of data references, if appropriate,
e.g. coaddition).
- There should be a way to run the task without persisting data. Typically the run method returns all
Expand Down

0 comments on commit 0b4002d

Please sign in to comment.