Rewrite raster documentation (#30)

nens · Feb 6, 2020 · af7f334 · af7f334
1 parent 8bb71fa
commit af7f334
Show file tree

Hide file tree

Showing 9 changed files with 461 additions and 343 deletions.
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -5,7 +5,9 @@ Changelog of dask-geomodeling
 2.2.2 (unreleased)
 ------------------
 
-- Nothing changed yet.
+- Reworked the docstrings of all rasterblocks.
+
+- Renamed the 'location' parameter of raster.misc.Step to 'value'.
 
 
 2.2.1 (2020-02-04)

diff --git a/dask_geomodeling/raster/base.py b/dask_geomodeling/raster/base.py
@@ -1,5 +1,5 @@
 """
-Module containing the raster block base classes.
+Module containing the RasterBlock base classes.
 """
 from datetime import datetime as Datetime
 
@@ -9,7 +9,7 @@
 class RasterBlock(Block):
     """ The base block for temporal rasters.
 
-    All raster blocks must be derived from this base class and must implement
+    All RasterBlocks must be derived from this base class and must implement
     the following attributes:
 
     - ``period``: a tuple of datetimes

diff --git a/dask_geomodeling/raster/combine.py b/dask_geomodeling/raster/combine.py
@@ -147,17 +147,21 @@ class Group(BaseCombine):
     """
     Combine multiple rasters into a single one.
 
-    :param args: multiple RasterBlocks to be combined.
-    :type args: list of RasterBlock
+    Operation to combine multiple rasters into one along all three axes (x, y
+    and temporal). To only fill 'no data' values of input rasters that have the
+    same temporal resolution ``dask_geomodeling.raster.elemwise.FillNoData``
+    is preferred.
 
-    Values at equal timesteps in the contributing rasters are pasted left to
-    right. Therefore values from rasters that are more 'to the left' are
-    shadowed by values from rasters more 'to the right'. However, 'no data'
-    values are transparent and do not shadow underlying data values.
+    Values at equal timesteps in the contributing rasters are considered
+    starting with the leftmost input raster. Therefore, values from rasters
+    that are more 'to the right' are shown in the result. 'no data' values are
+    transparent and will show data of rasters more 'to the left'.
 
-    In the case of aligned equidistant time characteristics, the
-    procedure will use slicing in the processing of the result for
-    optimum performance.
+    Args:
+      *args (list of RasterBlocks): list of rasters to be combined.
+
+    Returns:
+      RasterBlock that combines all input rasters
     """
 
     def get_stores(self, start, stop):