Merge branch 'main' into issue-urfave#2145

Author: dearchap

docs/v3/examples/arguments/advanced.md

@@ -7,7 +7,7 @@ search:
 
 The [Basics] showed how to access arguments for a command. They are all retrieved as strings which is fine
 but it we need to say get integers or timestamps the user would have to convert from string to desired type. 
-To ease the burden on users the `cli` library offers predefined `{Type}Arg` and `{Type}Args` structure to faciliate this
+To ease the burden on users the `cli` library offers predefined `{Type}Arg` and `{Type}Args` structure to faciliate this.
 The value of the argument can be retrieved using the `command.{Type}Arg()` function. For e.g
 
 <!-- {
@@ -152,9 +152,9 @@ func main() {
 
 Some things to note about multi value arguments
 
-1. They are of `{Type}Args` type rather than `{Type}Arg` to differentiate them from single value arguments
-2. The `Max` field needs to be defined to a non zero value without which it cannot be parsed
-3. `Max` field value needs to be greater than the `Min` field value
+1. They are of `{Type}Args` type rather than `{Type}Arg` to differentiate them from single value arguments.
+2. The `Max` field needs to be defined to a non zero value without which it cannot be parsed.
+3. `Max` field value needs to be greater than the `Min` field value.
 
 As with single value args the destination field can be set
 
@@ -221,4 +221,4 @@ the following to the end of the Arguments slice and retrieve them as a slice
 &StringArgs{
 	Max: -1,
 },
-```
+```

docs/v3/examples/completions/customizations.md

@@ -5,7 +5,7 @@ search:
   boost: 2
 ---
 
-If default completion isnt sufficient additional customizations are available 
+If default completion isn't sufficient additional customizations are available 
 
 - custom auto-completion
 - customizing completion command

docs/v3/examples/full-api-example.md

@@ -144,7 +144,7 @@ func main() {
 			&cli.FloatFlag{Name: "howmuch"},
 			&cli.IntFlag{Name: "longdistance", Validator: func (t int) error {
 				if t < 10 {
-					return fmt.Errorf("10 miles isnt long distance!!!!")
+					return fmt.Errorf("10 miles isn't long distance!!!!")
 				}
 				return nil
 			}},

godoc-current.txt

@@ -131,6 +131,15 @@ COPYRIGHT:
     cli.go uses text/template to render templates. You can render custom help
     text by setting this variable.
 
+var ShowAppHelp = showAppHelp
+    ShowAppHelp is an action that displays the help
+
+var ShowCommandHelp = showCommandHelp
+    ShowCommandHelp prints help for the given command
+
+var ShowSubcommandHelp = showSubcommandHelp
+    ShowSubcommandHelp prints help for the given subcommand
+
 var SubcommandHelpTemplate = `NAME:
    {{template "helpNameTemplate" .}}
 
@@ -195,22 +204,13 @@ func HandleExitCoder(err error)
 
     This function is the default error-handling behavior for an App.
 
-func ShowAppHelp(cmd *Command) error
-    ShowAppHelp is an action that displays the help.
-
 func ShowAppHelpAndExit(cmd *Command, exitCode int)
     ShowAppHelpAndExit - Prints the list of subcommands for the app and exits
     with exit code.
 
-func ShowCommandHelp(ctx context.Context, cmd *Command, commandName string) error
-    ShowCommandHelp prints help for the given command
-
 func ShowCommandHelpAndExit(ctx context.Context, cmd *Command, command string, code int)
     ShowCommandHelpAndExit - exits with code after showing help
 
-func ShowSubcommandHelp(cmd *Command) error
-    ShowSubcommandHelp prints help for the given subcommand
-
 func ShowSubcommandHelpAndExit(cmd *Command, exitCode int)
     ShowSubcommandHelpAndExit - Prints help for the given subcommand and exits
     with exit code.

help.go

@@ -44,6 +44,15 @@ var HelpPrinterCustom helpPrinterCustom = printHelpCustom
 // VersionPrinter prints the version for the App
 var VersionPrinter = printVersion
 
+// ShowAppHelp is an action that displays the help
+var ShowAppHelp = showAppHelp
+
+// ShowCommandHelp prints help for the given command
+var ShowCommandHelp = showCommandHelp
+
+// ShowSubcommandHelp prints help for the given subcommand
+var ShowSubcommandHelp = showSubcommandHelp
+
 func buildHelpCommand(withAction bool) *Command {
 	cmd := &Command{
 		Name:      helpName,
@@ -131,7 +140,7 @@ func ShowAppHelpAndExit(cmd *Command, exitCode int) {
 }
 
 // ShowAppHelp is an action that displays the help.
-func ShowAppHelp(cmd *Command) error {
+func showAppHelp(cmd *Command) error {
 	tmpl := cmd.CustomRootCommandHelpTemplate
 	if tmpl == "" {
 		tracef("using RootCommandHelpTemplate")
@@ -270,8 +279,7 @@ func ShowCommandHelpAndExit(ctx context.Context, cmd *Command, command string, c
 	os.Exit(code)
 }
 
-// ShowCommandHelp prints help for the given command
-func ShowCommandHelp(ctx context.Context, cmd *Command, commandName string) error {
+func showCommandHelp(ctx context.Context, cmd *Command, commandName string) error {
 	for _, subCmd := range cmd.Commands {
 		if !subCmd.HasName(commandName) {
 			continue
@@ -322,8 +330,7 @@ func ShowSubcommandHelpAndExit(cmd *Command, exitCode int) {
 	os.Exit(exitCode)
 }
 
-// ShowSubcommandHelp prints help for the given subcommand
-func ShowSubcommandHelp(cmd *Command) error {
+func showSubcommandHelp(cmd *Command) error {
 	HelpPrinter(cmd.Root().Writer, SubcommandHelpTemplate, cmd)
 	return nil
 }

testdata/godoc-v3.x.txt

@@ -131,6 +131,15 @@ COPYRIGHT:
     cli.go uses text/template to render templates. You can render custom help
     text by setting this variable.
 
+var ShowAppHelp = showAppHelp
+    ShowAppHelp is an action that displays the help
+
+var ShowCommandHelp = showCommandHelp
+    ShowCommandHelp prints help for the given command
+
+var ShowSubcommandHelp = showSubcommandHelp
+    ShowSubcommandHelp prints help for the given subcommand
+
 var SubcommandHelpTemplate = `NAME:
    {{template "helpNameTemplate" .}}
 
@@ -195,22 +204,13 @@ func HandleExitCoder(err error)
 
     This function is the default error-handling behavior for an App.
 
-func ShowAppHelp(cmd *Command) error
-    ShowAppHelp is an action that displays the help.
-
 func ShowAppHelpAndExit(cmd *Command, exitCode int)
     ShowAppHelpAndExit - Prints the list of subcommands for the app and exits
     with exit code.
 
-func ShowCommandHelp(ctx context.Context, cmd *Command, commandName string) error
-    ShowCommandHelp prints help for the given command
-
 func ShowCommandHelpAndExit(ctx context.Context, cmd *Command, command string, code int)
     ShowCommandHelpAndExit - exits with code after showing help
 
-func ShowSubcommandHelp(cmd *Command) error
-    ShowSubcommandHelp prints help for the given subcommand
-
 func ShowSubcommandHelpAndExit(cmd *Command, exitCode int)
     ShowSubcommandHelpAndExit - Prints help for the given subcommand and exits
     with exit code.