Merge pull request #44 from ecmwf/feature/review-docs

Review docs

Author: sandorkertesz

src/earthkit/geo/constants.py

@@ -13,10 +13,10 @@
 r"""Latitude of the north pole in degrees."""
 
 SOUTH_POLE_LAT = -90
-r"""Latitude of the south pole in degrees"""
+r"""Latitude of the south pole in degrees."""
 
 FULL_ANGLE = 360.0
 r"""Full angle in degrees."""
 
 STRAIGHT_ANGLE = 180.0
-r"""Half angle in degrees"""
+r"""Half angle in degrees."""

src/earthkit/geo/figure.py

@@ -9,7 +9,7 @@
 
 
 class Figure:
-    """Figure representing the size and shape of a spheroid"""
+    """Figure representing the size and shape of a spheroid."""
 
     pass
 

src/earthkit/geo/regrid/backends/db.py

@@ -555,11 +555,11 @@ def __len__(self):
         return len(self.index)
 
     def _clear_index(self):
-        """For testing only"""
+        """For testing only."""
         self._index = None
 
     def _reset(self):
-        """For testing only"""
+        """For testing only."""
         self._index = None
         self._accessor.reset()
 

src/earthkit/geo/regrid/data/xarray.py

@@ -94,7 +94,7 @@ def _distinct_lons(lons):
 
 
 # TODO: move this code to earthkit-geo
-class XarrrayGeographyBuilder:
+class XarrayGeographyBuilder:
     def __init__(self, grid_spec):
         self.grid = GridWrapper(grid_spec)
         self.grid_spec = grid_spec
@@ -255,7 +255,7 @@ def get_out_geo(grid):
         if out_grid is None:
             raise ValueError("grid must be provided")
 
-        out_geo = XarrrayGeographyBuilder(out_grid)
+        out_geo = XarrayGeographyBuilder(out_grid)
         return out_geo
 
     @staticmethod
@@ -347,7 +347,7 @@ def _regrid(da):
 
         # The output geography might have changed, so we need to create a new geography builder
         # with the new grid spec
-        out_geo = XarrrayGeographyBuilder(method.out_grid)
+        out_geo = XarrayGeographyBuilder(method.out_grid)
 
         self.add_geo_coords(ds_out, out_geo)
 

src/earthkit/geo/regrid/gridspec.py

@@ -125,7 +125,7 @@ def spec(self):
 class CustomGridSpec(GridSpec):
     """Custom grid spec that cannot be parsed by eckit.geo.
 
-    This is a placeholder for now, and can be extended in the future to suppor
+    This is a placeholder for now, and can be extended in the future to support
     custom gridspecs.
     """
 

src/earthkit/geo/utils/config.py

@@ -42,7 +42,7 @@ def explain(self):
 
 
 class ValuesValidator(Validator):
-    """Check if value is in a list of valid values"""
+    """Check if value is in a list of valid values."""
 
     def __init__(self, values):
         self.values = values
@@ -55,7 +55,7 @@ def explain(self):
 
 
 class ListValidator(Validator):
-    """Check if a list of values is in a list of valid values"""
+    """Check if a list of values is in a list of valid values."""
 
     def __init__(self, values):
         self.values = values
@@ -209,7 +209,7 @@ def validate(self, name, value):
 
 @contextmanager
 def new_config(s):
-    """Context manager to create new config"""
+    """Context manager to create new config."""
     CONFIG._stack.append(s)
     CONFIG._notify()
     try:

src/earthkit/geo/utils/memcache.py

@@ -36,7 +36,7 @@ def matrix_size(m):
 
 
 def estimate_matrix_size(entry):
-    """Estimate the size of a matrix entry"""
+    """Estimate the size of a matrix entry."""
     try:
         return entry["_raw"]["memory"]
     except Exception as e:
@@ -281,7 +281,7 @@ def _create_with_pre_check(self, find_entry, create_from_entry, *args):
         return create_from_entry(entry)
 
     def update(self):
-        """Called when settings change"""
+        """Called when settings change."""
         if self._has_settings:
             from earthkit.geo.utils.config import CONFIG
 
@@ -323,7 +323,7 @@ def _reduce(self, target_size=None):
             self.policy.reduce(target_size=target_size)
 
     def clear(self):
-        """Clear the cache"""
+        """Clear the cache."""
         with self.lock:
             self._clear()
 
@@ -339,7 +339,7 @@ def _curr_mem(self):
         return sum(v.size for v in self.items.values())
 
     def info(self):
-        """Report cache statistics"""
+        """Report cache statistics."""
         with self.lock:
             return _CacheInfo(
                 self.hits,