Add link to performance info in parameter docstring of strategy

isciences · Aug 30, 2024 · 80c2f82 · 80c2f82
1 parent 484d10b
commit 80c2f82
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 3 deletions.
diff --git a/python/doc/performance.rst b/python/doc/performance.rst
@@ -20,6 +20,7 @@ With relatively few polygons (hydrologic levels 1-6, up 3500 polygons) processin
 As the number of polygons increases, the resolution of the population raster becomes less significant. 
 At hydrologic levels 9 and 12 (approximately 1 million and 2 million polygons, respectively), increasing the resolution by a factor of 120 increases runtime by only 45%.
 
+.. _performance-processing-strategies:
 
 Processing strategies
 ---------------------

diff --git a/python/src/exactextract/exact_extract.py b/python/src/exactextract/exact_extract.py
@@ -377,15 +377,17 @@ def exact_extract(
             should be copied from the input features into
             the output.
        strategy: Specifies the strategy to use when processing features.
-                 Must be set to one of:
+          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``,
                    read the corresponding pixels from ``rast``/``weights``,
                    and compute the summary operations. This offers predictable
                    memory consumption but may be inefficient if the order of
-                   features in ``vec`` causes the same raster blocks to be read
-                   and decompressed.
+                   features in ``vec`` causes the same, relatively large raster
+                   blocks to be read and decompressed many times.
 
                  - ``"raster-sequential"``:
                    iterate over chunks of pixels in ``rast``, identify the intersecting