From aaf0ccb30d4cd4eb1930425429d61365dee50ff5 Mon Sep 17 00:00:00 2001 From: Stefaan Lippens Date: Mon, 18 Mar 2024 13:11:14 +0100 Subject: [PATCH] Issue #550/#551 vector_to_raster docs fine-tuning --- openeo/rest/vectorcube.py | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/openeo/rest/vectorcube.py b/openeo/rest/vectorcube.py index fee829b46..a0302ecf6 100644 --- a/openeo/rest/vectorcube.py +++ b/openeo/rest/vectorcube.py @@ -560,16 +560,17 @@ def apply_dimension( ) return self.process(process_id="apply_dimension", arguments=arguments) - def vector_to_raster(self, target) -> openeo.rest.datacube.DataCube: + def vector_to_raster(self, target: openeo.rest.datacube.DataCube) -> openeo.rest.datacube.DataCube: """ - Converts this vector cube into a :py:class:`~openeo.rest.datacube.DataCube`. + Converts this vector cube (:py:class:`VectorCube`) into a raster data cube (:py:class:`~openeo.rest.datacube.DataCube`). The bounding polygon of homogenous areas of pixels is constructed. - .. warning:: experimental process: not generally supported, API subject to change. + :param target: a reference raster data cube to adopt the CRS/projection/resolution from. - :return: a :py:class:`~openeo.rest.datacube.DataCube` + .. warning:: ``vector_to_raster`` is an experimental, non-standard process. It is not widely supported, and its API is subject to change. .. versionadded:: 0.28.0 + """ # TODO: this parameter sniffing is a temporary workaround until # the `target` parameter name rename has fully settled