Finetune Parameter.spatial_extent docs and defaults

Author: soxofaan

docs/udp.rst

@@ -134,7 +134,7 @@ Some useful parameter helpers (class methods of the :py:class:`~openeo.api.proce
 -   :py:meth:`Parameter.geojson() <openeo.api.process.Parameter.geojson>` to create
     a parameter for specifying a GeoJSON geometry.
 -   :py:meth:`Parameter.spatial_extent() <openeo.api.process.Parameter.spatial_extent>` to create
-    a spatial_extent parameter that is exactly the same as the corresponding parameter in `load_collection` and `load_stac`.
+    a spatial_extent parameter that is exactly the same as the corresponding parameter in ``load_collection`` and ``load_stac``.
 
 
 

openeo/api/process.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+import textwrap
 import warnings
 from typing import List, Optional, Union
 
@@ -279,23 +280,15 @@ def bounding_box(
         }
         return cls(name=name, description=description, schema=schema, **kwargs)
 
-    _spatial_extent_description = """Limits the data to process to the specified bounding box or polygons.
-
-For raster data, the process loads the pixel into the data cube if the point at the pixel center intersects with the bounding box or any of the polygons (as defined in the Simple Features standard by the OGC).
-For vector data, the process loads the geometry into the data cube if the geometry is fully within the bounding box or any of the polygons (as defined in the Simple Features standard by the OGC). Empty geometries may only be in the data cube if no spatial extent has been provided.
-
-Empty geometries are ignored.
-Set this parameter to null to set no limit for the spatial extent. """
-
     @classmethod
     def spatial_extent(
         cls,
         name: str = "spatial_extent",
-        description: str = _spatial_extent_description,
+        description: Optional[str] = None,
         **kwargs,
     ) -> Parameter:
         """
-        Helper to easily create a 'spatial_extent' parameter, which is compatible with the 'load_collection' argument of
+        Helper to easily create a 'spatial_extent' parameter, which is compatible with the ``load_collection`` argument of
         the same name. This allows to conveniently create user-defined processes that can be applied to a bounding box and vector data
         for spatial filtering. It is also possible for users to set to null, and define spatial filtering using other processes.
 
@@ -307,6 +300,26 @@ def spatial_extent(
 
         .. versionadded:: 0.32.0
         """
+        if description is None:
+            description = textwrap.dedent(
+                """
+                Limits the data to process to the specified bounding box or polygons.
+
+                For raster data, the process loads the pixel into the data cube if the point
+                at the pixel center intersects with the bounding box or any of the polygons
+                (as defined in the Simple Features standard by the OGC).
+
+                For vector data, the process loads the geometry into the data cube if the geometry
+                is fully within the bounding box or any of the polygons (as defined in the
+                Simple Features standard by the OGC). Empty geometries may only be in the
+                data cube if no spatial extent has been provided.
+
+                Empty geometries are ignored.
+
+                Set this parameter to null to set no limit for the spatial extent.
+                """
+            ).strip()
+
         schema = [
             {
                 "title": "Bounding Box",

tests/api/test_process.py

@@ -178,22 +178,20 @@ def test_parameter_reencode(kwargs, expected):
 
 def test_parameter_spatial_extent():
     assert Parameter.spatial_extent().to_dict() == {
-        "description": "Limits the data to process to the specified bounding box or "
-        "polygons.\n"
+        "description": "Limits the data to process to the specified bounding box or polygons.\n"
         "\n"
-        "For raster data, the process loads the pixel into the data "
-        "cube if the point at the pixel center intersects with the "
-        "bounding box or any of the polygons (as defined in the Simple "
-        "Features standard by the OGC).\n"
-        "For vector data, the process loads the geometry into the data "
-        "cube if the geometry is fully within the bounding box or any "
-        "of the polygons (as defined in the Simple Features standard "
-        "by the OGC). Empty geometries may only be in the data cube if "
-        "no spatial extent has been provided.\n"
+        "For raster data, the process loads the pixel into the data cube if the point\n"
+        "at the pixel center intersects with the bounding box or any of the polygons \n"
+        "(as defined in the Simple Features standard by the OGC).\n"
+        "\n"
+        "For vector data, the process loads the geometry into the data cube if the geometry \n"
+        "is fully within the bounding box or any of the polygons (as defined in the \n"
+        "Simple Features standard by the OGC). Empty geometries may only be in the \n"
+        "data cube if no spatial extent has been provided.\n"
         "\n"
         "Empty geometries are ignored.\n"
-        "Set this parameter to null to set no limit for the spatial "
-        "extent. ",
+        "\n"
+        "Set this parameter to null to set no limit for the spatial extent.",
         "name": "spatial_extent",
         "schema": [
             {