docs(_comp_compgen_commands): document return value

scop · akinomyoga · web-flow · commit 214c85e1584c · 2023-06-03T08:21:29.000+03:00
Co-authored-by: Koichi Murase &lt;myoga.murase@gmail.com&gt;
diff --git a/bash_completion b/bash_completion
@@ -2702,6 +2702,9 @@ _complete_as_root()
 }
 
 # Complete on available commands, subject to `no_empty_cmd_completion`.
+# @return True (0) if one or more completions are generated, or otherwise False
+# (1).  Note that it returns 1 even when the completion generation is canceled
+# by `shopt -s no_empty_cmd_completion`.
 #
 # @since 2.12
 _comp_compgen_commands()

Original file line number	Diff line number	Diff line change
`@@ -2702,6 +2702,9 @@ _complete_as_root()`
`2702`	`2702`	`}`
`2703`	`2703`
`2704`	`2704`	# Complete on available commands, subject to `no_empty_cmd_completion`.
	`2705`	`+# @return True (0) if one or more completions are generated, or otherwise False`
	`2706`	`+# (1). Note that it returns 1 even when the completion generation is canceled`
	`2707`	+# by `shopt -s no_empty_cmd_completion`.
`2705`	`2708`	`#`
`2706`	`2709`	`# @since 2.12`
`2707`	`2710`	`_comp_compgen_commands()`