Skip to content

Commit

Permalink
Merge pull request #1956 from BlackHole1/improve-flags-docs
Browse files Browse the repository at this point in the history
docs(flag): add `UseShortOptionHandling` description
  • Loading branch information
dearchap authored Aug 13, 2024
2 parents f21e902 + 584e28a commit 9114559
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions docs/v2/examples/flags.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,9 +104,11 @@ See full list of flags at https://pkg.go.dev/github.com/urfave/cli/v2

For bool flags you can specify the flag multiple times to get a count(e.g -v -v -v or -vvv)

> If you want to support the `-vvv` flag, you need to set `App.UseShortOptionHandling`.
<!-- {
"args": ["&#45;&#45;foo", "&#45;&#45;foo"],
"output": "count 2"
"args": ["&#45;&#45;f", "&#45;&#45;f", "&#45;fff", "&#45;f"],
"output": "count 6"
} -->
```go
package main
Expand All @@ -123,10 +125,12 @@ func main() {
var count int

app := &cli.App{
UseShortOptionHandling: true,
Flags: []cli.Flag{
&cli.BoolFlag{
Name: "foo",
Usage: "foo greeting",
Aliases: []string{"f"},
Count: &count,
},
},
Expand Down

0 comments on commit 9114559

Please sign in to comment.