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-10497: Fix minor typos in main.dox #32

Merged
merged 3 commits into from
May 10, 2017
Merged

DM-10497: Fix minor typos in main.dox #32

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d44f237
Fix minor typos in main.dox
r-owen May 9, 2017
31b278d
Add missing parameter documentation
r-owen May 10, 2017
9d1b2d7
Further cleanup of task override docs
r-owen May 10, 2017
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
14 changes: 7 additions & 7 deletions doc/main.dox
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,19 +167,19 @@ Note that:
\subsection pipeBase_argumentParser_argumentFiles Argument Files

You may specify long or repetitive command-line arguments in text files and reference those files
using @@path.
using `@`<i>path</i>.

The contents of the files are identical to the command line, except that long lines
must not have a \\ continuation character. For example if the file `foo` contains:
must not have a \\ continuation character. For example if the file `foo.txt` contains:
\code
--id visit=54123^55523 raft=1,1^2,1
--config someParam=someValue --configfile configOverrideFilePath
\endcode

you can then reference it with `@@foo` and mix that with other command-line arguments
you can then reference it with `@foo.txt` and mix that with other command-line arguments
(including `--id` and `--config`):
\code
myTask.py inputPath @@foo --config anotherParam=anotherValue --output outputPath
myTask.py inputPath @foo.txt --config anotherParam=anotherValue --output outputPath
\endcode

\subsection pipeBase_argumentParser_configOverride Overriding Configuration Parameters
Expand Down Expand Up @@ -250,13 +250,13 @@ notation. Here is an example:
you lose all configuration overrides for both the old and new task. This limitation is not
shared by \ref lsst.pex.config.registry.RegistryField "lsst.pex.config.RegistryField".

To retarget a subtask is specified as an
To retarget a subtask specified as an
\ref lsst.pex.config.registry.RegistryField "lsst.pex.config.RegistryField"
set the `name` property of the field. Overriding config parameters is a bit more complicated
than for \ref lsst.pex.config.configurableField.ConfigurableField "lsst.pex.config.ConfigurableField":
you can set the `active` attribute of the field to override the currently active subtask,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be something like "you can use the `active` attribute to override parameters of the currently active subtask"?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I took another cleanup pass on this section, in case you'd like to look at it. I hope it's an improvement.

or use dictionary access notation to override any registered subtask. On the other hand,
retargeting does not lose any config overrides for any registered subtask.
or use dictionary access notation to override a config parameter for any registered subtask.
On the other hand, retargeting does not lose any config overrides for any registered subtask.
Here is an example that assumes the same FooTask is defined
in module .../foo.py and registered using name "foo":

Expand Down
10 changes: 7 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 @@ -513,8 +513,9 @@ def writeConfig(self, butler, clobber=False, doBackup=True):
@param[in] butler data butler used to write the config.
The config is written to dataset type self._getConfigName()
@param[in] clobber a boolean flag that controls what happens if a config already has been saved:
- True: overwrite the existing config
- True: overwrite or rename the existing config, depending on `doBackup`
- False: raise TaskError if this config does not match the existing config
@param[in] doBackup if clobbering, should we backup the old files?
"""
configName = self._getConfigName()
if configName is None:
Expand Down Expand Up @@ -547,8 +548,9 @@ def writeSchemas(self, butler, clobber=False, doBackup=True):
Each schema is written to the dataset type specified as the key in the dict returned by
\ref task.Task.getAllSchemaCatalogs "getAllSchemaCatalogs".
@param[in] clobber a boolean flag that controls what happens if a schema already has been saved:
- True: overwrite the existing schema
- True: overwrite or rename the existing schema, depending on `doBackup`
- False: raise TaskError if this schema does not match the existing schema
@param[in] doBackup if clobbering, should we backup the old files?

@warning if clobber is False and an existing schema does not match a current schema,
then some schemas may have been saved successfully and others may not, and there is no easy way to
Expand Down Expand Up @@ -590,7 +592,9 @@ def writePackageVersions(self, butler, clobber=False, doBackup=True, dataset="pa
Note that this operation is subject to a race condition.

@param[in] butler data butler used to read/write the package versions
@param[in] clobber overwrite any existing config? no comparison will be made
@param[in] clobber a boolean flag that controls what happens if versions already have been saved:
- True: overwrite or rename the existing version info, depending on `doBackup`
- False: raise TaskError if this version info does not match the existing
@param[in] doBackup if clobbering, should we backup the old files?
@param[in] dataset name of dataset to read/write
"""
Expand Down