Skip to content

Commit

Permalink
DOCS: Add whatsnew for ruff pydocstyle compliance (#5700)
Browse files Browse the repository at this point in the history
* added whatsnew

* add another entry
  • Loading branch information
tkknight authored Feb 13, 2024
1 parent 44de598 commit 90c4a1a
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/src/whatsnew/latest.rst
Original file line number Diff line number Diff line change
Expand Up @@ -227,6 +227,13 @@ This document explains the changes made to Iris for this release

#. `@bjlittle`_ replaced `black`_ with `ruff`_. (:pull:`5634`)

#. `@tkknight`_ and `@bjlittle`_ (reviewer) updated codebase to be compliant with
almost all of the rules for `ruff pydocstyle`_.
(https://github.com/SciTools/iris/issues/5625#issuecomment-1859159734)

#. `@tkknight`_ and `@bjlittle`_ (reviewer) updated codebase to ensure docstrings
that are not covered by the ruff checks, are consistent with numpydocstyle.
(:issue:`4721`)

.. comment
Whatsnew author names (@github name) in alphabetical order. Note that,
Expand All @@ -243,3 +250,4 @@ This document explains the changes made to Iris for this release
.. _NEP29 Drop Schedule: https://numpy.org/neps/nep-0029-deprecation_policy.html#drop-schedule
.. _codespell: https://github.com/codespell-project/codespell
.. _split attributes project: https://github.com/orgs/SciTools/projects/5?pane=info
.. _ruff pydocstyle: https://docs.astral.sh/ruff/rules/#pydocstyle-d

0 comments on commit 90c4a1a

Please sign in to comment.