Skip to content

Commit aaf0ccb

Browse files
committed
Issue #550/#551 vector_to_raster docs fine-tuning
1 parent 2eea6dc commit aaf0ccb

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

openeo/rest/vectorcube.py

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -560,16 +560,17 @@ def apply_dimension(
560560
)
561561
return self.process(process_id="apply_dimension", arguments=arguments)
562562

563-
def vector_to_raster(self, target) -> openeo.rest.datacube.DataCube:
563+
def vector_to_raster(self, target: openeo.rest.datacube.DataCube) -> openeo.rest.datacube.DataCube:
564564
"""
565-
Converts this vector cube into a :py:class:`~openeo.rest.datacube.DataCube`.
565+
Converts this vector cube (:py:class:`VectorCube`) into a raster data cube (:py:class:`~openeo.rest.datacube.DataCube`).
566566
The bounding polygon of homogenous areas of pixels is constructed.
567567
568-
.. warning:: experimental process: not generally supported, API subject to change.
568+
:param target: a reference raster data cube to adopt the CRS/projection/resolution from.
569569
570-
:return: a :py:class:`~openeo.rest.datacube.DataCube`
570+
.. warning:: ``vector_to_raster`` is an experimental, non-standard process. It is not widely supported, and its API is subject to change.
571571
572572
.. versionadded:: 0.28.0
573+
573574
"""
574575
# TODO: this parameter sniffing is a temporary workaround until
575576
# the `target` parameter name rename has fully settled

0 commit comments

Comments
 (0)