From 07ed3e7c3078723b55687bf4b262d24ef1645c7d Mon Sep 17 00:00:00 2001 From: Matthew Holt Date: Fri, 29 Jul 2022 16:56:02 -0600 Subject: [PATCH] Minor docs clarification Related to #4565 --- cmd/commandfuncs.go | 2 +- cmd/commands.go | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/cmd/commandfuncs.go b/cmd/commandfuncs.go index fff8d017..9e979aed 100644 --- a/cmd/commandfuncs.go +++ b/cmd/commandfuncs.go @@ -647,7 +647,7 @@ commands: ) 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" diff --git a/cmd/commands.go b/cmd/commands.go index 51960f34..e454f7b6 100644 --- a/cmd/commands.go +++ b/cmd/commands.go @@ -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. 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 -development environment.`, +changes. ⚠️ This can make unintentional config changes easier; only use this +option in a local development environment.`, Flags: func() *flag.FlagSet { fs := flag.NewFlagSet("run", flag.ExitOnError) fs.String("config", "", "Configuration file")