@@ -360,20 +360,21 @@ will run on all supported platforms and versions of Python.
360360
361361 .. _tox : https://tox.readthedocs.io/
362362
363- * If you know your changes do not need to be tested (this is very rare!), all
364- CIs can be skipped for a given commit by including ``[ci skip] `` or
365- ``[skip ci] `` in the commit message. If you know only a subset of CIs need
366- to be run (e.g., if you are changing some block of plain reStructuredText and
367- want only CircleCI to run to render the result), individual CIs can be
368- skipped on individual commits as well by using the following substrings
369- in commit messages:
370-
371- - GitHub Actions: ``[skip actions] ``
372- - AppVeyor: ``[skip appveyor] `` (must be in the first line of the commit)
373- - Azure Pipelines: ``[skip azp] ``
374- - CircleCI: ``[skip circle] ``
375-
376- If you only want to run documentation CI you can pass ``[ci doc] ``.
363+ * If you know only a subset of CIs need to be run, this can be controlled on
364+ individual commits by including the following substrings in commit messages:
365+
366+ - ``[ci doc] ``: restrict the CI to documentation checks. For when you only
367+ changed documentation.
368+ - ``[skip circle] ``: skip the documentation build check. For when you didn't
369+ change documentation.
370+ - Unit tests can be turned off for individual platforms with
371+
372+ - ``[skip actions] ``: GitHub Actions
373+ - ``[skip appveyor] `` (must be in the first line of the commit): AppVeyor
374+ - ``[skip azp] ``: Azure Pipelines
375+
376+ - ``[skip ci] ``: skip all CIs. Use this only if you know your changes do not
377+ need to be tested at all, which is very rare.
377378
378379.. _pr-squashing :
379380
0 commit comments