DM-10497: Fix minor typos in main.dox #32
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Fix two doxygen warnings by documenting `doBackup` in two methods and tweak surrounding docs to make the documentation more uniform between methods with those same arguments.
ctslater
reviewed
May 10, 2017
doc/main.dox
Outdated
| @@ -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, | |||
There was a problem hiding this comment.
Should this be something like "you can use the `active` attribute to override parameters of the currently active subtask"?
There was a problem hiding this comment.
I took another cleanup pass on this section, in case you'd like to look at it. I hope it's an improvement.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.