parse/pargs: add ShorthandFunc comment

gobwas · Sep 20, 2021 · 18d540a · 18d540a
1 parent fc1a947
commit 18d540a
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/parse/pargs/posix.go b/parse/pargs/posix.go
@@ -23,6 +23,8 @@ type Parser struct {
 	// ShorthandFunc allows user to define custom way of picking shorthand
 	// version of flag with given name.
 	// Shorthand field must be true when setting ShorthandFunc.
+	// Returning empty string means that no shorthand is possible for given
+	// name.
 	ShorthandFunc func(string) string
 
 	pos   int