Skip to content

Commit 875f575

Browse files
committed
document short command
1 parent 49c7dce commit 875f575

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@ As a tool, `ni-python-styleguide` is installed like any other script:
2525
pip install ni-python-styleguide
2626
```
2727

28+
The script name `nps` is a short-name for `ni-python-styleguide`, and may be used in place of `ni-python-styleguide` in any CLI command.
29+
2830
### Linting
2931

3032
To lint, just run the `lint` subcommand (from within the project root, or lower):
@@ -34,7 +36,7 @@ ni-python-styleguide lint
3436
# or
3537
ni-python-styleguide lint ./dir/
3638
# or
37-
ni-python-styleguide lint module.py
39+
nps lint module.py
3840
```
3941

4042
The rules enforced are all rules documented in the written convention, which are marked as enforced.

0 commit comments

Comments
 (0)