Skip to content

Commit 84bf7c3

Browse files
authored
Better explain how to test the linters
1 parent 07ba8db commit 84bf7c3

1 file changed

Lines changed: 12 additions & 5 deletions

File tree

.github/test_plan.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -112,20 +112,27 @@ foo = 42 # Marked as a blacklisted name.
112112

113113
#### Other linters
114114

115-
You can always use the `Run Linting` command to immediately trigger a newly installed linter.
115+
**Note**:
116+
- You can use the `Run Linting` command to run a newly installed linter
117+
- When the extension installs a new linter, it turns off all other linters
116118

117119
- [ ] flake8 works
120+
- [ ] `Select linter` lists the linter and installs it if necessary
118121
- [ ] mypy works
122+
- [ ] `Select linter` lists the linter and installs it if necessary
119123
- [ ] pep8 works
124+
- [ ] `Select linter` lists the linter and installs it if necessary
120125
- [ ] prospector works
126+
- [ ] `Select linter` lists the linter and installs it if necessary
121127
- [ ] pydocstyle works
128+
- [ ] `Select linter` lists the linter and installs it if necessary
122129
- [ ] pylama works
123-
- [ ] 3 or more linters work simultaneously
124-
- [ ] `Run Linting` runs all linters
125-
- [ ] The `Select Linter` command lists all the above linters and prompts to install a linter when missing
130+
- [ ] `Select linter` lists the linter and installs it if necessary
131+
- [ ] 3 or more linters work simultaneously (make sure you have turned on the linters in your `settings.json`)
132+
- [ ] `Run Linting` runs all activated linters
126133
- [ ] `"python.linting.enabled": false` disables all linters
127134
- [ ] The `Enable Linting` command changes `"python.linting.enabled"`
128-
- [ ] `"python.linting.lintOnSave` works
135+
- [ ] `"python.linting.lintOnSave` works
129136

130137
### [Editing](https://code.visualstudio.com/docs/python/editing)
131138

0 commit comments

Comments
 (0)