X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=docs%2Ftox-guide.rst;h=2ba005c69d90b6f3c93ca3dc7efa4cfad7addb0b;hb=HEAD;hp=1ede63a3c2ef130330899a9ef175b553fdcd856f;hpb=cf3a29d3e9f11331a9cab1a4dc59b0e0d96ac9c0;p=transportpce.git diff --git a/docs/tox-guide.rst b/docs/tox-guide.rst index 1ede63a3c..6473ffb06 100644 --- a/docs/tox-guide.rst +++ b/docs/tox-guide.rst @@ -42,7 +42,7 @@ Tox configuration ----------------- `Tox` configuration is written in the `tox.ini` file at the root folder of the Git project. -Please read `tox official documentation `_ for more details. +Please read `tox official documentation `_ for more details. For tox users, the most important parameter in the `[tox]` section is `envlist`. It specifies which profiles to run by default (i.e. when tox is called without the option `-e`). The option `-e` overrides this parameter and allows to choose which profiles to run. @@ -106,7 +106,7 @@ Some are even performed in the CI. Pre-commit profiles ------------------- -`Pre-commit `_ is another wrapper for linters that relies on `Git Hooks `_. +`Pre-commit `_ is another wrapper for linters that relies on `Git Hooks `_. It is particularly useful to address common programming issues such as triming trailing whitespaces or removing tabs.