diff --git a/docs/src/developers_guide/contributing_code_formatting.rst b/docs/src/developers_guide/contributing_code_formatting.rst index 6d48882652..bb3140e4f9 100644 --- a/docs/src/developers_guide/contributing_code_formatting.rst +++ b/docs/src/developers_guide/contributing_code_formatting.rst @@ -57,5 +57,13 @@ will look similar to:: .. note:: You can also run `black`_ and `flake8`_ manually. Please see the their officially documentation for more information. +Type Hinting +------------ +Iris is gradually adding +`type hints `_ into the +codebase. The reviewer will look for type hints in a pull request; if you're +not confident with these, feel free to work together with the reviewer to +add/improve them. + .. _pre-commit: https://pre-commit.com/ diff --git a/docs/src/whatsnew/latest.rst b/docs/src/whatsnew/latest.rst index c13974529a..753e7edfc6 100644 --- a/docs/src/whatsnew/latest.rst +++ b/docs/src/whatsnew/latest.rst @@ -181,6 +181,9 @@ This document explains the changes made to Iris for this release #. `@lbdreyer`_ added a section to the release documentation outlining the role of the :ref:`release_manager`. (:pull:`4413`) +#. `@trexfeathers`_ encouraged contributors to include type hinting in code + they are working on - :ref:`code_formatting`. (:pull:`4390`) + 💼 Internal ===========