Add more info about per-platform commands (#1753)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
tox-dev · Dec 21, 2020 · 6f84f18 · 6f84f18
1 parent b606064
commit 6f84f18
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 1 deletion.
diff --git a/CONTRIBUTORS b/CONTRIBUTORS
@@ -90,6 +90,7 @@ Paweł Adamczak
 Philip Thiem
 Pierre-Jean Campigotto
 Pierre-Luc Tessier Gagné
+Prakhar Gurunani
 Ronald Evers
 Ronny Pfannschmidt
 Selim Belhaouane

diff --git a/docs/changelog/1144.doc.rst b/docs/changelog/1144.doc.rst
@@ -0,0 +1 @@
+Document more info about using ``platform`` setting. - by :user:`prakhargurunani`
diff --git a/docs/config.rst b/docs/config.rst
@@ -386,7 +386,9 @@ Complete list of settings that you can put into ``testenv*`` sections:
 
     A testenv can define a new ``platform`` setting as a regular expression.
     If a non-empty expression is defined and does not match against the
-    ``sys.platform`` string the test environment will be skipped.
+    ``sys.platform`` string the entire test environment will be skipped and
+    none of the commands will be executed. Running ``tox -e <platform_name>``
+    will run commands for a particular platform and skip the rest.
 
 .. conf:: setenv ^ MULTI-LINE-LIST
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Document more info about using ``platform`` setting. - by :user:`prakhargurunani`