DM-27500: add a comment in butler & pipetask subcommand about more options in butler --help #98
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
n8pease
force-pushed
the
tickets/DM-27500
branch
from
052eba7
to
6296d62
Compare
timj
approved these changes
Nov 17, 2020
| @@ -137,3 +138,20 @@ def makePipelineActions(args, | |||
| elif args[i] in instrumentFlags: | |||
| pipelineActions.append(_ACTION_ADD_INSTRUMENT(args[i+1])) | |||
| return pipelineActions | |||
|
|
|||
|
|
|||
| class PipetaskCommand(MWCommand): | |||
There was a problem hiding this comment.
Given that the only difference between PipetaskCommand and ButlerCommand is the one string, could we set up ButlerCommand with an epilog attribute that says "See butler --help..." and then for PipetaskCommand it's a subclass of ButlerCommand that consists of a single override of the {{epilog}} value? That will stop us duplicating all the code here.
There was a problem hiding this comment.
I was worried about getting too cute trying to make them the same, but your suggestion seems like a good compromise, will do.
PipetaskCommand class allows pipetask-specific overrides of subcommand behaviors. This adds a comment to the end of every subcommand's help text, that more options are available using "pipetask --help" Removes the --log-level option from subcommands. There was other help text in the epilog that was specific to prototype development of chained subcommands, and should have been removed when we did not use that feature. It is now removed.
n8pease
force-pushed
the
tickets/DM-27500
branch
from
6296d62
to
003b124
Compare
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.
PipetaskCommand class allows pipetask-specific overrides of
subcommand behaviors.
This adds a comment to the end of every subcommand's help text,
that more options are available using "pipetask --help"
Removes the --log-level option from subcommands.
There was other help text in the epilog that was specific to
prototype development of chained subcommands, and should have
been removed when we did not use that feature. It is now
removed.