Add comment about cmd.Help()

chemotaxis · chemotaxis · commit 1e3bba5ff64c · 2021-06-16T22:28:41.000-04:00
The linter picked up that the error value from cmd.Help() isn't checked.

Even though cmd.Help() returns an error value, it's always nil. The
inner HelpFunc() function directly prints the error message instead of
returning an error value.
diff --git a/cmd/gh/main.go b/cmd/gh/main.go
@@ -173,6 +173,10 @@ func mainRun() exitCode {
 		lastArgument := expandedArgs[len(expandedArgs)-1]
 		askingForHelp := lastArgument == "--help" || lastArgument == "-h"
 		if askingForHelp {
+			// Even though cmd.Help() returns an error, the error value is
+			// always nil.  The inner function HelpFunc() prints an error
+			// directly if something's wrong with the text template, rather than
+			// returning the error value.
 			cmd.Help()
 			return exitOK
 		}
