From 88e4bc65f42cf6849ef31f140aab7b42ef9de1ca Mon Sep 17 00:00:00 2001 From: "Edward K. Ream" Date: Tue, 24 Sep 2024 15:02:49 -0500 Subject: [PATCH] Fix #9959: Update FAQ, with tweaks suggested by Grammarly (#9960) Co-authored-by: Pierre Sassoulas --- doc/faq.rst | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/doc/faq.rst b/doc/faq.rst index 3706c25914..a39c733619 100644 --- a/doc/faq.rst +++ b/doc/faq.rst @@ -67,12 +67,17 @@ to not be included as default messages. You can see the plugin you need to explicitly :ref:`load in the technical reference `. -I want to use pylint on each keystroke in my IDE, how can I do that ? +I want to run pylint on each keystroke in my IDE. How do I do that? --------------------------------------------------------------------- -Don't do it: pylint's full suite of checks is not fast enough for that and never -will be. pylint is best suited for linting on save for small projects, or for a continuous -integration job or a git ``pre-push`` hook for big projects. The larger your repository +Pylint full suite of checks will never be fast enough to run on every keystroke. +However, some IDEs can run pylint when the IDE opens or saves files. +See, for example, the +[Microsoft plugin for vs-code](https://github.com/microsoft/vscode-pylint?tab=readme-ov-file#pylint-extension-for-visual-studio-code). + + +That said, pylint is best suited for linting on save for small projects, for continuous +integration jobs, or a git ``pre-push`` hook for big projects. The larger your repository is, the slower pylint will be. If you want to make pylint faster for this type of use case, you can use the ``--errors-only``