summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorClaudiu Popa <pcmanticore@gmail.com>2018-11-29 15:20:24 +0100
committerClaudiu Popa <pcmanticore@gmail.com>2018-11-29 15:20:24 +0100
commit907ee7ad10be4efd6c65f3ade5f237c06085907a (patch)
tree39353b5c0b871ad4924f751ea1104303dc678aa4
parent0b24cb889fedec374c17b45c1a86f9ee356cc8a3 (diff)
downloadpylint-git-907ee7ad10be4efd6c65f3ade5f237c06085907a.tar.gz
Document the use of --recreate for tox. Close #2590
-rw-r--r--doc/development_guide/contribute.rst8
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/development_guide/contribute.rst b/doc/development_guide/contribute.rst
index 952cf265b..e74e606e2 100644
--- a/doc/development_guide/contribute.rst
+++ b/doc/development_guide/contribute.rst
@@ -77,6 +77,13 @@ your patch gets accepted.
python -m tox -epylint # for running Pylint over Pylint's codebase
python -m tox -eformatting # for running formatting checks over Pylint's codebase
+ * It's usually a good idea to run tox_ with ``--recreate``. This is needed because
+ the tox environment might use an older version of astroid_, which can cause various failures
+ when you are running against the latest pylint::
+
+ python -m tox --recreate # The entire tox environment is going to be recreated
+
+
* To run only a specific test suite, use a pattern for the test filename
(**without** the ``.py`` extension), as in::
@@ -158,6 +165,7 @@ current environment in order to have faster feedback. Run with::
.. _tox: http://tox.readthedocs.io/en/latest/
.. _pytest: http://pytest.readthedocs.io/en/latest/
.. _black: https://github.com/ambv/black
+.. _astroid: https://github.com/pycqa/astroid
Tips for Getting Started with Pylint Development