Minor docs clarification

Related to #4565
This commit is contained in:
Matthew Holt 2022-07-29 16:56:02 -06:00
parent 1e0cdc54f8
commit 07ed3e7c30
No known key found for this signature in database
GPG Key ID: 2A349DD577D586A5
2 changed files with 3 additions and 3 deletions

View File

@ -647,7 +647,7 @@ commands:
) )
if help := flagHelp(subcommand.Flags); help != "" { if help := flagHelp(subcommand.Flags); help != "" {
result += fmt.Sprintf("\nflags:\n%s", help) result += fmt.Sprintf("\nflags: (NOTE: prefix flags with `--` instead of `-`)\n%s", help)
} }
result += "\n" + fullDocs + "\n" result += "\n" + fullDocs + "\n"

View File

@ -137,8 +137,8 @@ The --resume flag will override the --config flag if there is a config auto-
save file. It is not an error if --resume is used and no autosave file exists. save file. It is not an error if --resume is used and no autosave file exists.
If --watch is specified, the config file will be loaded automatically after If --watch is specified, the config file will be loaded automatically after
changes. This is dangerous in production! Only use this option in a local changes. This can make unintentional config changes easier; only use this
development environment.`, option in a local development environment.`,
Flags: func() *flag.FlagSet { Flags: func() *flag.FlagSet {
fs := flag.NewFlagSet("run", flag.ExitOnError) fs := flag.NewFlagSet("run", flag.ExitOnError)
fs.String("config", "", "Configuration file") fs.String("config", "", "Configuration file")