Skip to content

Commit

Permalink
Add documentation for Use (#1188)
Browse files Browse the repository at this point in the history
  • Loading branch information
MichaelMure committed Aug 18, 2020
1 parent 81e0311 commit 8cfa4b4
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions command.go
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,14 @@ type FParseErrWhitelist flag.ParseErrorsWhitelist
// definition to ensure usability.
type Command struct {
// Use is the one-line usage message.
// Recommended syntax is as follow:
// [ ] identifies an optional argument. Arguments that are not enclosed in brackets are required.
// ... indicates that you can specify multiple values for the previous argument.
// | indicates mutually exclusive information. You can use the argument to the left of the separator or the
// argument to the right of the separator. You cannot use both arguments in a single use of the command.
// { } delimits a set of mutually exclusive arguments when one of the arguments is required. If the arguments are
// optional, they are enclosed in brackets ([ ]).
// Example: add [-F file | -D dir]... [-f format] profile
Use string

// Aliases is an array of aliases that can be used instead of the first word in Use.
Expand Down

0 comments on commit 8cfa4b4

Please sign in to comment.