Skip to content

Commit 48e39b5

Browse files
jamesptrexfeathers
andauthored
Apply suggestions from @trexfeathers code review
Co-authored-by: Martin Yeo <[email protected]>
1 parent 8480c21 commit 48e39b5

2 files changed

Lines changed: 5 additions & 6 deletions

File tree

docs/src/developers_guide/contributing_ci_tests.rst

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -45,11 +45,11 @@ Cirrus CI Test environment
4545
--------------------------
4646

4747
The test environment on the Cirrus-CI service is determined from the requirement files
48-
in `requirements/ci/py**.yml`. These are conda environment files that list the entire
49-
set of build, test and run requirements for iris.
48+
in ``requirements/ci/py**.yml``. These are conda environment files that list the entire
49+
set of build, test and run requirements for Iris.
5050

5151
For reproducible test results, these environments are resolved for all their dependencies
52-
and stored as lock files in `requirements/ci/nox.lock`. The test environments will not
52+
and stored as lock files in ``requirements/ci/nox.lock``. The test environments will not
5353
resolve the dependencies each time, instead they will use the lock file to reproduce the
5454
same exact environment each time.
5555

@@ -64,7 +64,7 @@ or simply::
6464

6565
and add the changed lockfiles to your pull request.
6666

67-
New lockfiles are generated automatically each week to ensure that iris continues to be
67+
New lockfiles are generated automatically each week to ensure that Iris continues to be
6868
tested against the latest available version of its dependencies.
6969

7070

@@ -137,4 +137,3 @@ See the `pre-commit.ci dashboard`_ for details of recent past and active Iris jo
137137
.. _Cirrus-CI Documentation: https://cirrus-ci.org/guide/writing-tasks/
138138
.. _.pre-commit-config.yaml: https://github.com/SciTools/iris/blob/master/.pre-commit-config.yaml
139139
.. _pre-commit.ci dashboard: https://results.pre-commit.ci/repo/github/5312648
140-

docs/src/developers_guide/contributing_pull_request_checklist.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ is merged. Before submitting a pull request please consider this list.
2929
#. **Check all modified and new source files conform to the required**
3030
:ref:`code_formatting`.
3131

32-
#. **Check all new dependencies added to the requirements/ci/*.yml files.** If
32+
#. **Check all new dependencies added to the ``requirements/ci/*.yml`` files.** If
3333
dependencies have been added then new nox testing lockfiles should be generated too,
3434
see :ref:`cirrus_test_env`.
3535

0 commit comments

Comments
 (0)