Skip to content

Commit

Permalink
Document all the option in --help
Browse files Browse the repository at this point in the history
  • Loading branch information
suchow committed Apr 9, 2016
1 parent 8fe2474 commit 96e034e
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions proselint/command_line.py
Original file line number Diff line number Diff line change
Expand Up @@ -76,17 +76,18 @@ def print_errors(filename, errors, output_json=False, compact=False):

@click.command(context_settings=CONTEXT_SETTINGS)
@click.version_option(__version__, '--version', '-v', message='%(version)s')
@click.option('--debug', '-d', is_flag=True)
@click.option('--clean', '-c', is_flag=True)
@click.option('--json', '-j', 'output_json', is_flag=True)
@click.option('--time', '-t', is_flag=True)
@click.option('--demo', is_flag=True)
@click.option('--compact', is_flag=True)
@click.option('--debug', '-d', is_flag=True, help="Give verbose output.")
@click.option('--clean', '-c', is_flag=True, help="Clear the cache.")
@click.option('--json', '-j', 'output_json', is_flag=True,
help="Output as JSON.")
@click.option('--time', '-t', is_flag=True, help="Time on a corpus.")
@click.option('--demo', is_flag=True, help="Run over demo file.")
@click.option('--compact', is_flag=True, help="Shorten output.")
@click.argument('paths', nargs=-1, type=click.Path())
@close_cache_shelves_after
def proselint(paths=None, version=None, clean=None, debug=None,
output_json=None, time=None, demo=None, compact=None):
"""Define the linter command line API."""
"""A CLI for proselint, a linter for prose."""
if time:
click.echo(timing_test())
return
Expand Down

0 comments on commit 96e034e

Please sign in to comment.