From 3e0e91560acc9f9af23548f357e1d0fa1d4052f9 Mon Sep 17 00:00:00 2001 From: Tremain Knight <2108488+tkknight@users.noreply.github.com> Date: Wed, 3 Jan 2024 11:36:26 +0000 Subject: [PATCH 1/3] ruff compliance for D106. --- .ruff.toml | 2 +- lib/iris/fileformats/netcdf/loader.py | 4 ++++ 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/.ruff.toml b/.ruff.toml index c35507b5c3..38bbc354ef 100644 --- a/.ruff.toml +++ b/.ruff.toml @@ -29,7 +29,7 @@ lint.ignore = [ "D101", # Missing docstring in public class "D102", # Missing docstring in public method "D104", # Missing docstring in public package - "D106", # Missing docstring in public nested class + #"D106", # Missing docstring in public nested class # (D-3) Temporary, before an initial review, either fix ocurrences or move to (2). "D100", # Missing docstring in public module "D103", # Missing docstring in public function diff --git a/lib/iris/fileformats/netcdf/loader.py b/lib/iris/fileformats/netcdf/loader.py index 31b1774f19..6f69b6e64d 100644 --- a/lib/iris/fileformats/netcdf/loader.py +++ b/lib/iris/fileformats/netcdf/loader.py @@ -662,7 +662,11 @@ def load_cubes(file_sources, callback=None, constraints=None): class ChunkControl(threading.local): + """Provide user control of Chunk Control.""" + class Modes(Enum): + """Modes Enums.""" + DEFAULT = auto() FROM_FILE = auto() AS_DASK = auto() From 34ad437a7fcadae8f534edb29c7d9061ddf74c68 Mon Sep 17 00:00:00 2001 From: Tremain Knight <2108488+tkknight@users.noreply.github.com> Date: Wed, 3 Jan 2024 11:38:40 +0000 Subject: [PATCH 2/3] ruff compliance for D106. --- .ruff.toml | 1 - 1 file changed, 1 deletion(-) diff --git a/.ruff.toml b/.ruff.toml index 38bbc354ef..f159f0afca 100644 --- a/.ruff.toml +++ b/.ruff.toml @@ -29,7 +29,6 @@ lint.ignore = [ "D101", # Missing docstring in public class "D102", # Missing docstring in public method "D104", # Missing docstring in public package - #"D106", # Missing docstring in public nested class # (D-3) Temporary, before an initial review, either fix ocurrences or move to (2). "D100", # Missing docstring in public module "D103", # Missing docstring in public function From d500041bf860d3cf980a58bc5aa366d3146a4435 Mon Sep 17 00:00:00 2001 From: Tremain Knight <2108488+tkknight@users.noreply.github.com> Date: Thu, 4 Jan 2024 15:05:37 +0000 Subject: [PATCH 3/3] ruff compliance for D417 and D104. --- .ruff.toml | 2 -- docs/gallery_tests/__init__.py | 2 ++ docs/src/developers_guide/documenting/__init__.py | 1 + 3 files changed, 3 insertions(+), 2 deletions(-) diff --git a/.ruff.toml b/.ruff.toml index f159f0afca..4ea04e7380 100644 --- a/.ruff.toml +++ b/.ruff.toml @@ -25,10 +25,8 @@ lint.ignore = [ # (D-1) Permanent "D105", # Missing docstring in magic method # (D-2) Temporary, to be removed when we are more compliant. Rare cases mmove to (1). - "D417", # Missing argument descriptions in the docstring "D101", # Missing docstring in public class "D102", # Missing docstring in public method - "D104", # Missing docstring in public package # (D-3) Temporary, before an initial review, either fix ocurrences or move to (2). "D100", # Missing docstring in public module "D103", # Missing docstring in public function diff --git a/docs/gallery_tests/__init__.py b/docs/gallery_tests/__init__.py index 091e997248..9468138e04 100644 --- a/docs/gallery_tests/__init__.py +++ b/docs/gallery_tests/__init__.py @@ -2,3 +2,5 @@ # # This file is part of Iris and is released under the BSD license. # See LICENSE in the root of the repository for full licensing details. + +"""Gallery Tests.""" diff --git a/docs/src/developers_guide/documenting/__init__.py b/docs/src/developers_guide/documenting/__init__.py index e69de29bb2..6e031999e7 100644 --- a/docs/src/developers_guide/documenting/__init__.py +++ b/docs/src/developers_guide/documenting/__init__.py @@ -0,0 +1 @@ +# noqa: D104