Skip to content

Commit 5ff51fe

Browse files
committed
Better --help info with basic usage and help on PLUGIN arg
1 parent d414d52 commit 5ff51fe

1 file changed

Lines changed: 12 additions & 2 deletions

File tree

vimdoc/args.py

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,18 @@ def Source(path):
1717
return path
1818

1919

20-
parser = argparse.ArgumentParser('vimdoc', description='Generate vim helpfiles')
20+
parser = argparse.ArgumentParser(
21+
'vimdoc',
22+
formatter_class=argparse.RawTextHelpFormatter,
23+
description='''\
24+
Generate vim helpfiles
25+
26+
Basic usage:
27+
%(prog)s vim-someplugin/
28+
(or %(prog)s .)''')
2129
shtab.add_argument_to(parser)
22-
parser.add_argument('plugin', type=Source, metavar='PLUGIN').complete = shtab.DIR
30+
parser.add_argument(
31+
'plugin', type=Source, metavar='PLUGIN',
32+
help='a vim plugin directory').complete = shtab.DIR
2333
parser.add_argument('--version', action='version',
2434
version='%(prog)s ' + vimdoc.__version__)

0 commit comments

Comments
 (0)