Skip to content

Commit

Permalink
Small docstring formatting improvement
Browse files Browse the repository at this point in the history
  • Loading branch information
theroggy committed Sep 4, 2024
1 parent 8fa1913 commit d98927f
Showing 1 changed file with 18 additions and 18 deletions.
36 changes: 18 additions & 18 deletions python/src/exactextract/exact_extract.py
Original file line number Diff line number Diff line change
Expand Up @@ -369,24 +369,24 @@ def exact_extract(
"""Calculate zonal statistics.
Args:
rast: A :py:class:`RasterSource` or filename that can be opened
by GDAL/rasterio/xarray.
vec: A :py:class:`FeatureSource` or filename that can be opened
by GDAL/fiona
ops: A list of :py:class:`Operation` objects, or strings that
rast: A :py:class:`RasterSource` or filename that can be opened
by GDAL/rasterio/xarray.
vec: A :py:class:`FeatureSource` or filename that can be opened
by GDAL/fiona
ops: A list of :py:class:`Operation` objects, or strings that
can be used to construct them (e.g., ``"mean"``, ``"quantile(q=0.33)"``).
Check out :doc:`Available operations </operations>` for more information.
weights: An optional :py:class:`RasterSource` or filename for
weights: An optional :py:class:`RasterSource` or filename for
weights to be used in weighted operations.
include_cols: An optional list of columns from the
include_cols: An optional list of columns from the
input features to be included into the output.
include_geom: Flag indicating whether the geometry
include_geom: Flag indicating whether the geometry
should be copied from the input features into
the output.
strategy: Specifies the strategy to use when processing features.
Detailed performance notes are available in
:ref:`Performance - Processing strategies <performance-processing-strategies>`.
Must be set to one of:
strategy: Specifies the strategy to use when processing features.
Detailed performance notes are available in
:ref:`Performance - Processing strategies <performance-processing-strategies>`.
Must be set to one of:
- ``"feature-sequential"`` (the default):
iterate over the features in ``vec``,
Expand All @@ -401,11 +401,11 @@ def exact_extract(
features from ``vec``, and compute statistics. This performs better
than ``strategy="feature-sequential"`` in some cases, but comes at
a cost of higher memory usage.
max_cells_in_memory: Indicates the maximum number of raster cells that should be
loaded into memory at a given time.
grid_compat_tol: require value and weight grids to align within
max_cells_in_memory: Indicates the maximum number of raster cells that should be
loaded into memory at a given time.
grid_compat_tol: require value and weight grids to align within
``grid_compat_tol`` times the smaller of the two grid resolutions
output: An :py:class:`OutputWriter` or one of the following strings:
output: An :py:class:`OutputWriter` or one of the following strings:
- "geojson" (the default): return a list of GeoJSON-like features
- "pandas": return a ``pandas.DataFrame`` or ``geopandas.GeoDataFrame``,
Expand All @@ -415,10 +415,10 @@ def exact_extract(
need to maintain results for all features in memory at a
single time, which may be significant for operations with
large result sizes such as ``cell_id``, ``values``, etc.
output_options: an optional dictionary of options passed to the
output_options: an optional dictionary of options passed to the
:py:class:`writer.JSONWriter`, :py:class:`writer.PandasWriter`, or
:py:class:`writer.GDALWriter`.
progress: if `True`, a progress bar will be displayed. Alternatively, a function
progress: if `True`, a progress bar will be displayed. Alternatively, a function
may be provided that will be called with the completion fraction and a
status message.
""" # noqa: E501
Expand Down

0 comments on commit d98927f

Please sign in to comment.