psw/borgmatic
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

tweak docstring, add comment

Browse source
This commit is contained in:
Isaac 2023-05-06 11:37:38 -07:00
parent d732059979
commit a047f856a1
No known key found for this signature in database
GPG key ID: E69FB5A841448A48
1 changed files with 3 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
borgmatic/commands/completion.py
View file

@ -91,8 +91,8 @@ def has_unknown_required_param_options(action: Action):
''' '''
A catch-all for options that take a required parameter, but we don't know what the parameter is. A catch-all for options that take a required parameter, but we don't know what the parameter is.
This should be used last. These are actions that take something like a glob, a list of numbers, or a string. This should be used last. These are actions that take something like a glob, a list of numbers, or a string.
There is no way to know what the valid options are, but we need to prevent another argument from being shown,
and let the user know that they need to provide a parameter. Actions that match this pattern should not show the normal arguments, because those are unlikely to be valid.
''' '''
return ( return (
action.required is True action.required is True
@ -215,6 +215,7 @@ def fish_completion():
) )
+ ('\n# global flags',) + ('\n# global flags',)
+ tuple( + tuple(
# -n is checked in order, so put faster / more likely to be true checks first
f'''complete -c borgmatic -f -n "$exact_option_condition" -a '{' '.join(action.option_strings)}' -d {shlex.quote(action.help)}{exact_options_completion(action)}''' f'''complete -c borgmatic -f -n "$exact_option_condition" -a '{' '.join(action.option_strings)}' -d {shlex.quote(action.help)}{exact_options_completion(action)}'''
for action in top_level_parser._actions for action in top_level_parser._actions
if len(action.option_strings) > 0 if len(action.option_strings) > 0