Document default Usage messages.

creachadair · Jan 3, 2024 · 618fa8d · 618fa8d
1 parent e382ed7
commit 618fa8d
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/command.go b/command.go
@@ -192,6 +192,11 @@ type C struct {
 
 	// A terse usage summary for the command. Multiple lines are allowed.
 	// Each line should be self-contained for a particular usage sense.
+	//
+	// The name of the command will be automatically inserted at the front of
+	// each usage line if it is not present. If no usage is defined, the help
+	// mechanism will generate a default based on the presence of flags and
+	// subcommands.
 	Usage string
 
 	// A detailed description of the command. Multiple lines are allowed.