Skip to content

Commit afaf21a

Browse files
committed
docs: short deprecation warnings
1 parent 01819a1 commit afaf21a

File tree

1 file changed

+5
-7
lines changed

1 file changed

+5
-7
lines changed

cli/helptext.go

+5-7
Original file line numberDiff line numberDiff line change
@@ -493,20 +493,18 @@ func subcommandText(width int, cmd *cmds.Command, rootName string, path []string
493493
return lines
494494
}
495495

496-
// Text printed after 'Warning: ' tag at the start of the command.
497-
// FIXME: We probably want to print more than its status in caps, maybe what
498-
// is the contract behind it, e.g., 'WARNING: DEPRECATED - This command
499-
// might be removed without prior notice'.
496+
// Text printed at the beginning of --help,
497+
// after 'WARNING: ' tag at the start of the command.
500498
func generateWarningText(cmd *cmds.Command) string {
501499
switch cmd.Status {
502500
case cmds.Active:
503501
return "" // We don't print a warning for a normal active command.
504502
case cmds.Deprecated:
505-
return "DEPRECATED"
503+
return "DEPRECATED, command will be removed in the future"
506504
case cmds.Experimental:
507-
return "EXPERIMENTAL"
505+
return "EXPERIMENTAL, command may change in future releases"
508506
case cmds.Removed:
509-
return "REMOVED"
507+
return "REMOVED, command is no longer available"
510508
default:
511509
panic("unknown command status")
512510
}

0 commit comments

Comments
 (0)