Add "D" checks to ruff config

doc/source/doi_role.py

@@ -20,6 +20,7 @@
 
 
 def doi_role(typ, rawtext, text, lineno, inliner, options=None, content=None):
+    """Create a doi role."""
     if options is None:
         options = {}
     if content is None:
@@ -34,6 +35,7 @@ def doi_role(typ, rawtext, text, lineno, inliner, options=None, content=None):
 
 
 def arxiv_role(typ, rawtext, text, lineno, inliner, options=None, content=None):
+    """Create an arxive role."""
     if options is None:
         options = {}
     if content is None:
@@ -48,12 +50,14 @@ def arxiv_role(typ, rawtext, text, lineno, inliner, options=None, content=None):
 
 
 def setup_link_role(app):
+    """Set up the role link."""
     app.add_role("doi", doi_role, override=True)
     app.add_role("DOI", doi_role, override=True)
     app.add_role("arXiv", arxiv_role, override=True)
     app.add_role("arxiv", arxiv_role, override=True)
 
 
 def setup(app):
+    """Set up the app."""
     app.connect("builder-inited", setup_link_role)
     return {"version": "0.1", "parallel_read_safe": True}

pyproject.toml

@@ -16,8 +16,9 @@ line_length = 120
 [tool.ruff]
 # See https://docs.astral.sh/ruff/rules/
 # In the future, add "A", "B", "S", "N", "D"
-select = ["E", "W", "F", "I", "PT", "TID", "C90", "Q", "T10", "T20"]
+select = ["D", "E", "W", "F", "I", "PT", "TID", "C90", "Q", "T10", "T20"]
 line-length = 120
+ignore = ["D417"]
 
 [tool.ruff.per-file-ignores]
 "satpy/tests/*" = ["S101"]  # assert allowed in tests

satpy/readers/atms_sdr_hdf5.py

@@ -15,8 +15,7 @@
 
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
-"""
-Reader for the ATMS SDR format.
+"""Reader for the ATMS SDR format.
 
 A reader for Advanced Technology Microwave Sounder (ATMS) SDR data as it
 e.g. comes out of the CSPP package for processing Direct Readout data.

satpy/readers/generic_image.py

@@ -15,8 +15,7 @@
 #
 # You should have received a copy of the GNU General Public License along with
 # satpy.  If not, see <http://www.gnu.org/licenses/>.
-"""
-Reader for generic image (e.g. gif, png, jpg, tif, geotiff, ...).
+"""Reader for generic image (e.g. gif, png, jpg, tif, geotiff, ...).
 
 Returns a dataset without calibration.  Includes coordinates if
 available in the file (eg. geotiff).

satpy/readers/gerb_l2_hr_h5.py

@@ -34,8 +34,7 @@
 
 
 def gerb_get_dataset(ds, ds_info):
-    """
-    Load a GERB dataset in memory from a HDF5 file or HDF5FileHandler.
+    """Load a GERB dataset in memory from a HDF5 file or HDF5FileHandler.
 
     The routine takes into account the quantisation factor and fill values.
     """

satpy/readers/ici_l1b_nc.py

@@ -176,8 +176,7 @@ def _interpolate_geo(
         latitude,
         n_samples,
     ):
-        """
-        Perform the interpolation of geographic coordinates from tie points to pixel points.
+        """Perform the interpolation of geographic coordinates from tie points to pixel points.
 
         Args:
             longitude: xarray DataArray containing the longitude dataset to
@@ -229,8 +228,7 @@ def _interpolate_viewing_angle(
         zenith,
         n_samples,
     ):
-        """
-        Perform the interpolation of angular coordinates from tie points to pixel points.
+        """Perform the interpolation of angular coordinates from tie points to pixel points.
 
         Args:
             azimuth: xarray DataArray containing the azimuth angle dataset to

satpy/readers/modis_l3.py

@@ -46,7 +46,6 @@ class ModisL3GriddedHDFFileHandler(HDFEOSGeoReader):
     """File handler for MODIS HDF-EOS Level 3 CMG gridded files."""
     def available_datasets(self, configured_datasets=None):
         """Automatically determine datasets provided by this file."""
-
         # Initialise set of variable names to carry through code
         handled_var_names = set()
 
@@ -112,7 +111,6 @@ def get_dataset(self, dataset_id, dataset_info):
 
     def _get_area_extent(self):
         """Get the grid properties."""
-
         # Now compute the data extent
         upperleft = self.metadata["GridStructure"]["GRID_1"]["UpperLeftPointMtrs"]
         lowerright = self.metadata["GridStructure"]["GRID_1"]["LowerRightMtrs"]

satpy/readers/scatsat1_l2b.py

@@ -26,8 +26,10 @@
 
 
 class SCATSAT1L2BFileHandler(BaseFileHandler):
+    """File handler for ScatSat level 2 files, as distributed by Eumetsat in HDF5 format."""
 
     def __init__(self, filename, filename_info, filetype_info):
+        """Initialize the file handler."""
         super(SCATSAT1L2BFileHandler, self).__init__(filename, filename_info, filetype_info)
         self.h5f = h5py.File(self.filename, "r")
         h5data = self.h5f["science_data"]
@@ -44,6 +46,7 @@ def __init__(self, filename, filename_info, filetype_info):
         self.longitude_scale = float(h5data.attrs["Longitude Scale"])
 
     def get_dataset(self, key, info):
+        """Get the dataset."""
         h5data = self.h5f["science_data"]
         stdname = info.get("standard_name")
 

satpy/tests/reader_tests/test_abi_l1b.py

@@ -131,25 +131,29 @@ def _create_fake_rad_dataset(rad: xr.DataArray, resolution: int) -> xr.Dataset:
 
 
 def generate_l1b_filename(chan_name: str) -> str:
+    """Generate a l1b filename."""
     return f"OR_ABI-L1b-RadC-M4{chan_name}_G16_s20161811540362_e20161811545170_c20161811545230_suffix.nc"
 
 
 @pytest.fixture()
 def c01_refl(tmp_path) -> xr.DataArray:
+    """Load c01 reflectances."""
     with _apply_dask_chunk_size():
         reader = _create_reader_for_data(tmp_path, "C01", None, 1000)
         return reader.load(["C01"])["C01"]
 
 
 @pytest.fixture()
 def c01_rad(tmp_path) -> xr.DataArray:
+    """Load c01 radiances."""
     with _apply_dask_chunk_size():
         reader = _create_reader_for_data(tmp_path, "C01", None, 1000)
         return reader.load([DataQuery(name="C01", calibration="radiance")])["C01"]
 
 
 @pytest.fixture()
 def c01_rad_h5netcdf(tmp_path) -> xr.DataArray:
+    """Load c01 radiances through h5netcdf."""
     shape = RAD_SHAPE[1000]
     rad_data = (np.arange(shape[0] * shape[1]).reshape(shape) + 1.0) * 50.0
     rad_data = (rad_data + 1.0) / 0.5
@@ -172,13 +176,15 @@ def c01_rad_h5netcdf(tmp_path) -> xr.DataArray:
 
 @pytest.fixture()
 def c01_counts(tmp_path) -> xr.DataArray:
+    """Load c01 counts."""
     with _apply_dask_chunk_size():
         reader = _create_reader_for_data(tmp_path, "C01", None, 1000)
         return reader.load([DataQuery(name="C01", calibration="counts")])["C01"]
 
 
 @pytest.fixture()
 def c07_bt_creator(tmp_path) -> Callable:
+    """Create a loader for c07 brightness temperatures."""
     def _load_data_array(
         clip_negative_radiances: bool = False,
     ):

satpy/tests/reader_tests/test_satpy_cf_nc.py

@@ -89,6 +89,7 @@ def _create_test_netcdf(filename, resolution=742):
 
 @pytest.fixture(scope="session")
 def cf_scene():
+    """Create a cf scene."""
     tstart = datetime(2019, 4, 1, 12, 0)
     tend = datetime(2019, 4, 1, 12, 15)
     data_visir = np.array([[1, 2], [3, 4]])
@@ -214,13 +215,15 @@ def cf_scene():
 
 @pytest.fixture()
 def nc_filename(tmp_path):
+    """Create an nc filename for viirs m band."""
     now = datetime.utcnow()
     filename = f"testingcfwriter{now:%Y%j%H%M%S}-viirs-mband-20201007075915-20201007080744.nc"
     return str(tmp_path / filename)
 
 
 @pytest.fixture()
 def nc_filename_i(tmp_path):
+    """Create an nc filename for viirs i band."""
     now = datetime.utcnow()
     filename = f"testingcfwriter{now:%Y%j%H%M%S}-viirs-iband-20201007075915-20201007080744.nc"
     return str(tmp_path / filename)

satpy/tests/reader_tests/test_viirs_vgac_l1c_nc.py

@@ -31,6 +31,7 @@
 
 @pytest.fixture()
 def nc_filename(tmp_path):
+    """Create an nc test data file and return its filename."""
     now = datetime.datetime.utcnow()
     filename = f"VGAC_VJ10XMOD_A{now:%Y%j_%H%M}_n004946_K005.nc"
     filename_str = str(tmp_path / filename)