mirror of
https://github.com/borgbackup/borg.git
synced 2024-09-19 08:18:10 +03:00
docs: format metavars more accurately
This commit is contained in:
parent
710ca196d8
commit
88ae1ebf33
17
setup.py
17
setup.py
@ -203,6 +203,17 @@ def detect_libb2(prefixes):
|
||||
long_description = re.compile(r'^\.\. highlight:: \w+$', re.M).sub('', long_description)
|
||||
|
||||
|
||||
def format_metavar(option):
|
||||
if option.nargs in ('*', '...'):
|
||||
return '[%s...]' % option.metavar
|
||||
elif option.nargs == '?':
|
||||
return '[%s]' % option.metavar
|
||||
elif option.nargs is None:
|
||||
return option.metavar
|
||||
else:
|
||||
raise ValueError('Can\'t format metavar %s, unknown nargs %s!' % (option.metavar, option.nargs))
|
||||
|
||||
|
||||
class build_usage(Command):
|
||||
description = "generate usage for each command"
|
||||
|
||||
@ -284,7 +295,7 @@ def write_usage(self, parser, fp):
|
||||
for option in parser._actions:
|
||||
if option.option_strings:
|
||||
continue
|
||||
fp.write(' ' + option.metavar)
|
||||
fp.write(' ' + format_metavar(option))
|
||||
fp.write('\n\n')
|
||||
|
||||
def write_options(self, parser, fp):
|
||||
@ -645,11 +656,11 @@ def gen_man_page(self, name, rst):
|
||||
|
||||
def write_usage(self, write, parser):
|
||||
if any(len(o.option_strings) for o in parser._actions):
|
||||
write(' <options> ', end='')
|
||||
write(' [options] ', end='')
|
||||
for option in parser._actions:
|
||||
if option.option_strings:
|
||||
continue
|
||||
write(option.metavar, end=' ')
|
||||
write(format_metavar(option), end=' ')
|
||||
|
||||
def write_options(self, write, parser):
|
||||
for group in parser._action_groups:
|
||||
|
Loading…
Reference in New Issue
Block a user