Skip to content

Commit 9cd43fe

Browse files
committed
docs(_comp_compgen): clarify @return
1 parent c1eb592 commit 9cd43fe

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

bash_completion

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -453,6 +453,8 @@ _comp_compgen__error_fallback()
453453
#
454454
# Note: The array option `-V arr` in bash >= 5.3 should be instead specified
455455
# as `-v arr` as a part of the `_comp_compgen` options.
456+
# @return True (0) if at least one completion is generated, False (1) if no
457+
# completion is generated, or 2 with an incorrect usage.
456458
#
457459
# Usage #2: _comp_compgen [-alR|-v arr|-c cur] name args...
458460
# Call the generator `_comp_compgen_NAME ARGS...` with the specified options.
@@ -470,6 +472,7 @@ _comp_compgen__error_fallback()
470472
# These variables are internally used to pass the effect of the options
471473
# [-alR|-v arr|-c cur] to the child calls of `_comp_compgen` in
472474
# `_comp_compgen_NAME`.
475+
# @return Exit status of the generator.
473476
#
474477
# @remarks When no options are supplied to _comp_compgen, `_comp_compgen NAME
475478
# args` is equivalent to the direct call `_comp_compgen_NAME args`. As the

0 commit comments

Comments
 (0)