Merge pull request #350 from brettmcintosh/help_text_fixes

Improve help text
This commit is contained in:
Anthony Sottile 2016-03-08 16:27:23 -08:00
commit 77a1a29c12

View file

@ -79,7 +79,8 @@ def main(argv=None):
run_parser.add_argument('hook', nargs='?', help='A single hook-id to run') run_parser.add_argument('hook', nargs='?', help='A single hook-id to run')
run_parser.add_argument( run_parser.add_argument(
'--color', default='auto', type=color.use_color, '--color', default='auto', type=color.use_color,
help='Whether to use color in output. Defaults to `auto`', help='Whether to use color in output. Choices are `always`, `never`'
', or `auto`. Defaults to `auto`.',
) )
run_parser.add_argument( run_parser.add_argument(
'--no-stash', default=False, action='store_true', '--no-stash', default=False, action='store_true',
@ -90,20 +91,20 @@ def main(argv=None):
) )
run_parser.add_argument( run_parser.add_argument(
'--origin', '-o', '--origin', '-o',
help='The origin branch\'s commit_id when using `git push`', help='The origin branch\'s commit_id when using `git push`.',
) )
run_parser.add_argument( run_parser.add_argument(
'--source', '-s', '--source', '-s',
help='The remote branch\'s commit_id when using `git push`', help='The remote branch\'s commit_id when using `git push`.',
) )
run_parser.add_argument( run_parser.add_argument(
'--allow-unstaged-config', default=False, action='store_true', '--allow-unstaged-config', default=False, action='store_true',
help='Allow an unstaged config to be present. Note that this will ' help='Allow an unstaged config to be present. Note that this will '
'be stashed before parsing unless --no-stash is specified' 'be stashed before parsing unless --no-stash is specified.'
) )
run_parser.add_argument( run_parser.add_argument(
'--hook-stage', choices=('commit', 'push'), default='commit', '--hook-stage', choices=('commit', 'push'), default='commit',
help='The stage during which the hook is fired e.g. commit or push', help='The stage during which the hook is fired e.g. commit or push.',
) )
run_mutex_group = run_parser.add_mutually_exclusive_group(required=False) run_mutex_group = run_parser.add_mutually_exclusive_group(required=False)
run_mutex_group.add_argument( run_mutex_group.add_argument(