Improve doc

ghiggi · Apr 7, 2024 · c2a843c · c2a843c
1 parent 1fdd9da
commit c2a843c
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 4 deletions.
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -238,7 +238,8 @@ Refer to the table below for a comprehensive summary of all CI tools employed to
 +----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
 | `CodeFactor <https://www.codefactor.io/>`__        | Automated code review and analysis tools                                                                                            |
 +----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
-
+| `Codacy <https://www.codacy.com/>`__               | Automated code review and analysis tools                                                                                            |
++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
 
 
 5. Code testing with pytest

diff --git a/docs/source/installation.rst b/docs/source/installation.rst
@@ -126,15 +126,15 @@ You can create a conda environment (i.e. with python 3.11) with:
 	conda create --name pycolorbar-dev-py311 python=3.11 --no-default-packages
 	conda activate pycolorbar-dev-py311
 
-Install the pycolorbar package dependencies
+Install the package dependencies
 ............................................
 
 .. code-block:: bash
 
 	conda install --only-deps pycolorbar
 
 
-Install the pycolorbar package in editable mode
+Install the package in editable mode
 ................................................
 
 Install the pycolorbar package in editable mode by executing the following command in the pycolorbar repository's root:
@@ -144,7 +144,7 @@ Install the pycolorbar package in editable mode by executing the following comma
 	pip install -e ".[dev]"
 
 
-Install pre-commit code quality checks
+Install code quality checks
 ..............................................
 
 Install the pre-commit hook by executing the following command in the pycolorbar repository's root:

diff --git a/docs/source/maintainers_guidelines.rst b/docs/source/maintainers_guidelines.rst
@@ -220,3 +220,5 @@ The table below summarizes the software tools utilized in our CI pipeline, descr
 +----------------------------------------------------------------------------------------------------+------------------------------------------------------------------+----------------------------------------------------------------------------------------------+
 | `CodeFactor <https://www.codefactor.io/>`__                                                        | Automated code review and analysis tools                         | `pycolorbar <https://www.codefactor.io/repository/github/ghiggi/pycolorbar>`__               |
 +----------------------------------------------------------------------------------------------------+------------------------------------------------------------------+----------------------------------------------------------------------------------------------+
+| `Codacy      <https://www.codacy.com/>`__                                                          | Automated code review and analysis tools                         | `pycolorbar <https://app.codacy.com/gh/ghiggi/pycolorbar/dashboard>`__                       |
++----------------------------------------------------------------------------------------------------+------------------------------------------------------------------+----------------------------------------------------------------------------------------------+