Standardize argparse help messages#2847
Merged
tgamblin merged 1 commit intospack:developfrom Jan 26, 2017
Merged
Conversation
becker33
reviewed
Jan 18, 2017
Member
becker33
left a comment
becker33
left a comment
There was a problem hiding this comment.
3 thoughts:
1: The help string for uninstall -a uses full sentences, and maybe should be formatted as such.
2: In general, I'm slightly opposed to using . to delimit sentences if we are not going to use capital letters to start them.
3: We need to update the description of the spec expression syntax at the top of spack -h. This can be a separate PR.
Member
Author
|
@becker33 Agreed. Some of the help messages are fairly long. Perhaps we could shorten them? If we don't, would it make sense to try to reword them or separate sentences with commas or semicolons? |
tgamblin
approved these changes
Jan 26, 2017
diaena
pushed a commit
to diaena/spack
that referenced
this pull request
May 26, 2017
amklinv
pushed a commit
that referenced
this pull request
Jul 17, 2017
healther
pushed a commit
to electronicvisions/spack
that referenced
this pull request
Jul 26, 2017
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
3 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.
If your run
spack helpon any particular command, you'll notice that some options start with a lowercase letter and end with a period, while others start with a capital letter and don't end with a period. This was really messing with my OCD, so I fixed it.I decided to standardize on starting with a lowercase letter and not ending with a period. Why? Because argparse automatically adds the
-h / --helpoption to every command, and that's what it uses. Yes, we could hack this if we really want to, but I don't see any reason to.