Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

DM-14073: Fix up docstring syntax #48

Merged
merged 1 commit into from
Apr 12, 2018
Merged

DM-14073: Fix up docstring syntax #48

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 3 additions & 3 deletions python/lsst/pipe/base/cmdLineTask.py
View file
Open in desktop
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
View file
Open in desktop
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