Minor docs clarification

Related to #4565

Matthew Holt committed Jul 29, 2022 at 16:56 UTC 07ed3e7c3078723b55687bf4b262d24ef1645c7d

2 files changed +3 -3

cmd/commandfuncs.go

+1 -1

@@ -647,7 +647,7 @@ commands:

647 )

648

649 if help := flagHelp(subcommand.Flags); help != "" {

650 - result += fmt.Sprintf("\nflags:\n%s", help)

650 + result += fmt.Sprintf("\nflags: (NOTE: prefix flags with `--` instead of `-`)\n%s", help)

651 }

652

653 result += "\n" + fullDocs + "\n"

cmd/commands.go

+2 -2

@@ -137,8 +137,8 @@ The --resume flag will override the --config flag if there is a config auto-

137 save file. It is not an error if --resume is used and no autosave file exists.

138

139 If --watch is specified, the config file will be loaded automatically after

140 -changes. ⚠️ This is dangerous in production! Only use this option in a local

141 -development environment.`,

140 +changes. ⚠️ This can make unintentional config changes easier; only use this

141 +option in a local development environment.`,

142 Flags: func() *flag.FlagSet {

143 fs := flag.NewFlagSet("run", flag.ExitOnError)

144 fs.String("config", "", "Configuration file")