Skip to content

docs: clarify SortFlags example with complete runnable program #488

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tomasaschan merged 1 commit into from
Jul 3, 2026
Merged

docs: clarify SortFlags example with complete runnable program #488

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 27 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -250,13 +250,35 @@ flags.MarkHidden("secretFlag")
## Disable sorting of flags
`pflag` allows you to disable sorting of flags for help and usage message.

`SortFlags` is a field on `FlagSet`, not a package-level variable. To disable
sorting on the default `CommandLine` flag set, use `pflag.CommandLine.SortFlags`.

**Example**:
```go
flags.BoolP("verbose", "v", false, "verbose output")
flags.String("coolflag", "yeaah", "it's really cool flag")
flags.Int("usefulflag", 777, "sometimes it's very useful")
flags.SortFlags = false
flags.PrintDefaults()
package main

import (
"fmt"

"github.com/spf13/pflag"
)

func main() {
flags := pflag.NewFlagSet("example", pflag.ContinueOnError)
flags.BoolP("verbose", "v", false, "verbose output")
flags.String("coolflag", "yeaah", "it's really cool flag")
flags.Int("usefulflag", 777, "sometimes it's very useful")
flags.SortFlags = false
flags.PrintDefaults()
fmt.Println()
}
```

For the default `CommandLine` flag set:

```go
pflag.CommandLine.SortFlags = false
pflag.PrintDefaults()
```
**Output**:
```
Expand Down
Loading