Skip to content

Commit b8c1bce

Browse files
authored
Merge pull request #2403 from adafruit/pylint-learn-command-name
Use pylint-learn as the pylint version, if installed
2 parents f8bbe61 + 5b534a6 commit b8c1bce

File tree

2 files changed

+13
-1
lines changed

2 files changed

+13
-1
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,15 @@ This is a work in progress.
2020

2121
[learn]: https://learn.adafruit.com/
2222

23+
## Running pylint locally
24+
Install a specific version of pylint under the name "pylint-learn":
25+
```
26+
pip install pipx
27+
pipx install --suffix=-learn pylint==2.7.1
28+
```
29+
Then use the `pylint_check` script to run pylint on the files or directories
30+
of your choice (note that your terminal *must* be in the top directory of
31+
Adafruit_Learning_System_Guides, not a sub-directory):
32+
```
33+
./pylint_check CircuitPython_Cool_Project
34+
```

pylint_check.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
#!/bin/bash
22

3-
PYLINT="`type -p pylint3 2>/dev/null || type -p pylint`"
3+
PYLINT="`type -p pylint-learn 2>/dev/null || type -p pylint3 2>/dev/null || type -p pylint`"
44
echo "Using pylint bin at $PYLINT"
55

66
# Use * as the default argument to avoid descending into hidden directories like .git

0 commit comments

Comments
 (0)