chore(cmd): print shortHelp if longHelp is empty #1011
Merged
+74
−14
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
github-actions
bot
added
📦 🤖 gnovm
tbruyelle
commented
Aug 1, 2023
| @@ -28,7 +28,7 @@ func newDocCmd(io *commands.IO) *commands.Command { | |||
| commands.Metadata{ | |||
| Name: "doc", | |||
| ShortUsage: "doc [flags] <pkgsym>", | |||
| ShortHelp: "get documentation for the specified package or symbol (type, function, method, or variable/constant).", | |||
| ShortHelp: "get documentation for the specified package or symbol (type, function, method, or variable/constant)", | |||
There was a problem hiding this comment.
ShortHelp shouldn't end with a dot. Eventually, a dot is added if ShortHelp is used when the command is executed with its help flag.
There was a problem hiding this comment.
I think it's better to let the point in the definition and have a more basic fprintf in command.go.
There was a problem hiding this comment.
Well, this ShortHelp is the only one that had a final dot, all others haven't.
In addition, if we add dots at the end of ShortHelp, this will result in this when listing sub-commands :
$ gno
USAGE
<subcommand> [flags] [<arg>...]
Runs the gno development toolkit
SUBCOMMANDS
mod Manage gno.mod.
test Runs the tests for the specified packages.
lint Runs the linter for the specified packages.
run Runs the specified gno files.
build Builds the specified gno package.
precompile Precompiles .gno files to .go.
clean Removes generated files and cached data.
repl Starts a GnoVM REPL.
doc get documentation for the specified package or symbol (type, function, method, or variable/constant).
IMO I prefer without the final dot.
Currenlty, `shortHelp` is used when the command is listed from its parent command, and `longHelp` is used when the command is executed with its help flag. What I found a little annoying is if `longHelp` is not provided, which is the case for the majority of commands, there's no text at all when the command is invoked with the help flag. This change ensures the `shortHelp` is printed if `longHelp` is empty.
tbruyelle
force-pushed
the
tbruyelle/chore/cmd-help
branch
from
5ab5189
to
b9cf465
Compare
moul
reviewed
Aug 1, 2023
| @@ -252,6 +252,8 @@ func usage(c *Command) string { | |||
|
|
|||
| if c.longHelp != "" { | |||
| fmt.Fprintf(&b, "%s\n\n", c.longHelp) | |||
| } else if c.shortHelp != "" { | |||
| fmt.Fprintf(&b, "%s.\n\n", c.shortHelp) | |||
There was a problem hiding this comment.
Suggested change
| fmt.Fprintf(&b, "%s.\n\n", c.shortHelp) | |
| fmt.Fprintf(&b, "%s\n\n", c.shortHelp) |
moul
approved these changes
Aug 1, 2023
harry-hov
approved these changes
Aug 3, 2023
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.
Currenlty,
shortHelpis used when the command is listed from its parent command, andlongHelpis used when the command is executed with its help flag.What I found a little annoying is if
longHelpis not provided, which is the case for the majority of commands, there's no text at all when the command is invoked with the help flag.This change ensures the
shortHelpis printed iflongHelpis empty.Example with `gno test` :
Before the change:
After the change:
Contributors' checklist...
BREAKING CHANGE: xxxmessage was included in the description