MAINT: update contributor guide concerning lint

gdementen · gdementen · commit 574adfea5b6c · 2023-09-13T15:40:59.000+02:00
(pytest-pep8 -&gt; ruff)
diff --git a/doc/source/contribute.rst b/doc/source/contribute.rst
@@ -23,8 +23,7 @@ It is built to various formats using `Sphinx <http://sphinx-doc.org/>`_
 and `nbsphinx <https://nbsphinx.readthedocs.io>`_.
 
 The unit tests are written using the `pytest library <https://docs.pytest.org>`_.
-The compliance with the PEP8 conventions is tested using the extension
-`pytest-pep8 <https://pypi.org/project/pytest-pep8/>`_.
+The compliance with the PEP8 conventions is tested using `ruff <https://github.com/astral-sh/ruff/>`_.
 
 Many editors and IDE exist to edit Python code and provide integration with version control tools (like git).
 A good IDE, such as PyCharm, can make many of the steps below much more efficient.
@@ -90,16 +89,15 @@ One of the easiest way to do it is via `Anaconda` or `Miniconda`:
 
 We'll now kick off a two-step process:
 
-1. Install the build dependencies
+1. Install the dependencies
 
 .. code-block:: none
 
-   # add 'conda-forge' channel (required to install some dependencies)
-   conda config --add channels conda-forge
-
-   # Create and activate the build environment
-   conda create -n larray_dev numpy pandas pytables pyqt qtpy matplotlib openpyxl xlsxwriter pytest pytest-pep8
+   # Create and activate the environment
+   conda create -n larray_dev numpy pandas pytables pyqt qtpy matplotlib openpyxl xlsxwriter pytest
    conda activate larray_dev
+   # Install ruff (as of September 2023, it is not available on Anaconda)
+   pip install ruff
 
 This will create the new environment, and not touch any of your existing environments,
 nor any existing Python installation.
@@ -114,7 +112,7 @@ To return to your root environment::
 
 See the full conda docs `here <http://conda.pydata.org/docs>`_.
 
-2. Build and install larray
+2. Install larray in "development mode"
 
 Install larray using the following command:
 
@@ -181,6 +179,12 @@ code conventions. Among others, this means:
 
 This summary should not prevent you from reading the PEP!
 
+You can check your code respects most of those conventions and some other style guidelines by running
+the following command in the project directory: ::
+
+  > ruff check .
+
+
 Step 3: Document your code
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -262,8 +266,6 @@ Step 4: Test your code
 
 Our unit tests are written using the `pytest library <https://docs.pytest.org>`_
 and our tests modules are located in `/larray/tests/`.
-We also use its extension `pytest-pep8 <https://pypi.org/project/pytest-pep8/>`_
-to check if the code is PEP8 compliant.
 The pytest library is able to automatically detect and run unit tests
 as long as you respect some conventions:
 
@@ -359,8 +361,8 @@ To submit a pull request:
 #. Click ``Send Pull Request``.
 
 This request then goes to the repository maintainers, and they will review the code.
-Your modifications will also be automatically tested by running the *larray* test suite on
-`Travis-CI <https://travis-ci.org/>`__ continuous integration service. A pull request will only be
+Your modifications will also be automatically tested by running the *larray* test suite via Github actions
+continuous integration service. A pull request will only be
 considered for merging when you have an all 'green' build.
 If any tests are failing, then you will get a red 'X', where you can click through to see the individual failed tests.
 
