sky-uk / bslint

A linter for the BrightScript language.
BSD 3-Clause "New" or "Revised" License
24 stars 9 forks source link

Main documentation is missing parameters #149

Closed siekermantechnology closed 7 years ago

siekermantechnology commented 7 years ago

I just pulled in bslint version 1.0.1 through pip3. When I run bslint -h, it gives me:

usage: bslint [-h] [--path PATH] [--lex] [--version]

BSLint: A linter for BrightScript.

optional arguments:
  -h, --help            show this help message and exit
  --path PATH, -p PATH  Specify directory or file
  --lex, -l             Runs only the lexer, without parsing the code
  --version, -v         Get current version

The documentation at https://github.com/sky-uk/bslint/blob/master/README.md doesn't mention the arguments, even though the --path / -p parameter is indeed needed.