Merge pull request #300 from johntruckenbrodt/docs/update

[snap] docstring improvements

pyroSAR/snap/auxil.py

@@ -1685,7 +1685,7 @@ def sub_parametrize(scene, geometry=None, offset=None, buffer=0.01, copyMetadata
         
          - :class:`~spatialist.vector.Vector`: a vector object in arbitrary CRS
          - :class:`str`: a name of a file that can be read with :class:`~spatialist.vector.Vector` in arbitrary CRS
-         - :class:`dict`: a dictionary with keys `xmin`, `xmax`, `ymin`, `ymax` in LatLon coordinates
+         - :class:`dict`: a dictionary with keys `xmin`, `xmax`, `ymin`, `ymax` in EPSG:4326 coordinates
     offset: tuple or None
         a tuple with pixel coordinates as (left, right, top, bottom)
     buffer: int or float

pyroSAR/snap/util.py

@@ -67,7 +67,7 @@ def geocode(infile, outdir, t_srs=4326, spacing=20, polarizations='all', shapefi
     outdir: str
         The directory to write the final files to.
     t_srs: int or str or osgeo.osr.SpatialReference
-        A target geographic reference system in WKT, EPSG, PROJ4 or OPENGIS format.
+        A target spatial reference system in WKT, EPSG, PROJ4 or OPENGIS format.
         See function :func:`spatialist.auxil.crsConvert()` for details.
         Default: `4326 <https://spatialreference.org/ref/epsg/4326/>`_.
     spacing: int or float, optional
@@ -76,8 +76,12 @@ def geocode(infile, outdir, t_srs=4326, spacing=20, polarizations='all', shapefi
         The polarizations to be processed; can be a string for a single polarization, e.g. 'VV', or a list of several
         polarizations, e.g. ['VV', 'VH']. With the special value 'all' (default) all available polarizations are
         processed.
-    shapefile: str or :py:class:`~spatialist.vector.Vector` or dict, optional
-        A vector geometry for subsetting the SAR scene to a test site. Default is None.
+    shapefile: str or :class:`~spatialist.vector.Vector` or dict, optional
+        A vector geometry for spatial subsetting:
+        
+         - :class:`~spatialist.vector.Vector`: a vector object in arbitrary CRS
+         - :class:`str`: a name of a file that can be read with :class:`~spatialist.vector.Vector` in arbitrary CRS
+         - :class:`dict`: a dictionary with keys `xmin`, `xmax`, `ymin`, `ymax` in EPSG:4326 coordinates
     scaling: {'dB', 'db', 'linear'}, optional
         Should the output be in linear or decibel scaling? Default is 'dB'.
     geocoding_type: {'Range-Doppler', 'SAR simulation cross correlation'}, optional
@@ -674,7 +678,7 @@ def noise_power(infile, outdir, polarizations, spacing, t_srs, refarea='sigma0',
     spacing: int or float
         The target pixel spacing in meters.
     t_srs: int or str or osgeo.osr.SpatialReference
-        A target geographic reference system in WKT, EPSG, PROJ4 or OPENGIS format.
+        A target spatial reference system in WKT, EPSG, PROJ4 or OPENGIS format.
     refarea: str
         either 'beta0', 'gamma0' or 'sigma0'.
     tmpdir: str