Fix #9959: Update FAQ, with tweaks suggested by Grammarly #9960
Conversation
Pierre-Sassoulas
added
Documentation 📗
Skip news 🔇
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #9960 +/- ##
=======================================
Coverage 95.80% 95.80%
=======================================
Files 174 174
Lines 18940 18940
=======================================
Hits 18146 18146
Misses 794 794 |
doc/faq.rst
Outdated
| Pylint will never be fast enough to run on every keystroke. | ||
|
|
||
| However, IDEs could run pylint automatically *in the background* | ||
| when the IDE saves changed Python files. Contact your IDE with a support request :-) |
There was a problem hiding this comment.
Maybe we should link to the vs code plugin, they've already added a lot of tooling for this.
There was a problem hiding this comment.
@jacobtylerwalls Good idea. I'll update the PR later today.
There was a problem hiding this comment.
| when the IDE saves changed Python files. Contact your IDE with a support request :-) | |
| when the IDE saves changed Python files. |
Some IDE do it already, some do not and might not like the influx of requests, let's remove the advice.
doc/faq.rst
Outdated
| @@ -67,12 +67,16 @@ to not be included as default messages. | |||
| You can see the plugin you need to explicitly :ref:`load in the technical reference | |||
| <user_guide/checkers/extensions:optional checkers>`. | |||
|
|
|||
| I want to use pylint on each keystroke in my IDE, how can I do that ? | |||
| --------------------------------------------------------------------- | |||
| I want to use run pylint automatically in my IDE. How do I do that? | |||
There was a problem hiding this comment.
| I want to use run pylint automatically in my IDE. How do I do that? | |
| I want to run pylint on each keystroke in my IDE. How do I do that? |
Automatically is not a problem, each keystroke though is.
doc/faq.rst
Outdated
| Pylint will never be fast enough to run on every keystroke. | ||
|
|
||
| However, IDEs could run pylint automatically *in the background* | ||
| when the IDE saves changed Python files. Contact your IDE with a support request :-) |
There was a problem hiding this comment.
| when the IDE saves changed Python files. Contact your IDE with a support request :-) | |
| when the IDE saves changed Python files. |
Some IDE do it already, some do not and might not like the influx of requests, let's remove the advice.
doc/faq.rst
Outdated
| integration job or a git ``pre-push`` hook for big projects. The larger your repository | ||
| Pylint will never be fast enough to run on every keystroke. | ||
|
|
||
| However, IDEs could run pylint automatically *in the background* |
There was a problem hiding this comment.
| However, IDEs could run pylint automatically *in the background* | |
| However, IDEs could run pylint automatically on the single file you're working on or in the background |
|
@Pierre-Sassoulas Thanks for your suggestions. Please review the changes at rev 96986d2. |
|
Thank you for making the doc better / more nuanced ! |
|
@Pierre-Sassoulas Thanks for your help and guidance :-) |
Type of Changes
Description
Update FAQ per #9959. (Closes #9959)