Pipeline: better help string for tiny command#263
Merged
taimontgomery merged 4 commits intomasterfrom Dec 15, 2022
Merged
Conversation
…n argparse `description` fields. Single newlines are replaced with a space as they are in vanilla argparse, and this is because our docstrings are length-limited per PEP8, but we don't want to maintain this same width when displayed in the terminal. Instead, help string content should adjust to fill the width of the terminal window. However, double newlines (\n\n) should be treated as intentional and should be preserved in the help string. Similarly, lines that begin with whitespace are likely intentional and desired; therefore indents following newlines are also preserved.
…ansparent" help configuration for argparse. You can still pass -h or --help but now the option itself isn't listed in the helpstring because it's essentially irrelevant for our userbase
…ion is now better organized, more complete, and up to date. Also changed setup-cwl's "None"/"none" argument to simply be case-insensitive
Collaborator
|
Tested successfully on ram1 dataset. Reviewed documentation. |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Closes #260
Note: branch issue-260 is derived from issue-258. PR #259 needs to be closed first, then this PR needs to have its base branch toggled in order to display an accurate record of file changes