From 3038bb2b39a0d8feee8c97a5ddb9ea9f3d543fca Mon Sep 17 00:00:00 2001 From: Bill Little Date: Tue, 18 Apr 2023 15:46:07 +0100 Subject: [PATCH] review actions --- docs/src/common_links.inc | 1 + docs/src/developers_guide/contributing_ci_tests.rst | 8 ++++++++ docs/src/whatsnew/3.5.rst | 2 +- 3 files changed, 10 insertions(+), 1 deletion(-) diff --git a/docs/src/common_links.inc b/docs/src/common_links.inc index 55461369ff..10a96ff420 100644 --- a/docs/src/common_links.inc +++ b/docs/src/common_links.inc @@ -6,6 +6,7 @@ .. _flake8: https://flake8.pycqa.org/en/stable/ .. _.flake8.yml: https://github.com/SciTools/iris/blob/main/.flake8 .. _cirrus-ci: https://cirrus-ci.com/github/SciTools/iris +.. _codespell: https://github.com/codespell-project/codespell .. _conda: https://docs.conda.io/en/latest/ .. _contributor: https://github.com/SciTools/scitools.org.uk/blob/master/contributors.json .. _core developers: https://github.com/SciTools/scitools.org.uk/blob/master/contributors.json diff --git a/docs/src/developers_guide/contributing_ci_tests.rst b/docs/src/developers_guide/contributing_ci_tests.rst index 8fa3361cb7..36c1b402b6 100644 --- a/docs/src/developers_guide/contributing_ci_tests.rst +++ b/docs/src/developers_guide/contributing_ci_tests.rst @@ -117,6 +117,14 @@ pull-requests given the `Iris`_ GitHub repository `.pre-commit-config.yaml`_. See the `pre-commit.ci dashboard`_ for details of recent past and active Iris jobs. +.. note:: + + The `codespell`_ ``pre-commit`` hook checks the spelling of the whole codebase + and documentation. This hook is configured in the ``[tool.codespell]`` section + of the ``pyproject.toml`` file. + + Append to the ``ignore-words-list`` option any **valid words** that are + considered **not** a typo and should **not** be corrected by `codespell`_. .. _.pre-commit-config.yaml: https://github.com/SciTools/iris/blob/main/.pre-commit-config.yaml .. _pre-commit.ci dashboard: https://results.pre-commit.ci/repo/github/5312648 diff --git a/docs/src/whatsnew/3.5.rst b/docs/src/whatsnew/3.5.rst index c5dfb9a1b4..f90586a7ac 100644 --- a/docs/src/whatsnew/3.5.rst +++ b/docs/src/whatsnew/3.5.rst @@ -45,7 +45,7 @@ This document explains the changes made to Iris for this release :ref:`documentation page` for further information. (:pull:`5144`) -#. `@rcomer`_ enabled lazy evaluation of :obj:`~iris.analysis.RMS` calcuations +#. `@rcomer`_ enabled lazy evaluation of :obj:`~iris.analysis.RMS` calculations with weights. (:pull:`5017`) #. `@schlunma`_ allowed the usage of cubes, coordinates, cell measures, or