Skip to content

Commit

Permalink
Fix doc
Browse files Browse the repository at this point in the history
  • Loading branch information
remi-braun committed Feb 27, 2024
1 parent 579ab3a commit 0e1584d
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
8 changes: 4 additions & 4 deletions sertit/rasters.py
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@ def path_or_xarr_or_dst_wrapper(path_or_ds: PATH_XARR_DS, *args, **kwargs) -> An
def get_nodata_mask(xds: AnyXrDataStructure) -> np.ndarray:
"""
.. deprecated:: 1.36.0
Use :py:mod:`rasters.get_data_mask` instead.
Use :py:func:`rasters.get_data_mask` instead.
"""
logs.deprecation_warning("This function is deprecated. Use 'get_data_mask' instead")
return get_data_mask(xds)
Expand Down Expand Up @@ -436,7 +436,7 @@ def get_valid_vector(xds: PATH_XARR_DS, default_nodata: int = 0) -> gpd.GeoDataF
Get the valid data of a raster, returned as a vector.
Pay attention that every nodata pixel will appear too.
If you want only the footprint of the raster, please use :py:mod:`rasters.get_footprint`.
If you want only the footprint of the raster, please use :py:func:`rasters.get_footprint`.
Args:
xds (PATH_XARR_DS): Path to the raster or a rasterio dataset or a xarray
Expand Down Expand Up @@ -471,7 +471,7 @@ def get_nodata_vector(ds: PATH_ARR_DS, default_nodata: int = 0) -> gpd.GeoDataFr
Get the nodata vector of a raster as a vector.
Pay attention that every nodata pixel will appear too.
If you want only the footprint of the raster, please use :py:mod:`rasters.get_footprint`.
If you want only the footprint of the raster, please use :py:func:`rasters.get_footprint`.
Args:
ds (PATH_ARR_DS): Path to the raster, its dataset, its :code:`xarray` or a tuple containing its array and metadata
Expand Down Expand Up @@ -1242,7 +1242,7 @@ def read_uint8_array(
Forces array to :code:`np.uint8`.
See :py:mod:`rasters.read_bit_array`.
See :py:func:`rasters.read_bit_array`.
Args:
bit_mask (np.ndarray): Bit array to read
Expand Down
2 changes: 1 addition & 1 deletion sertit/rasters_rio.py
Original file line number Diff line number Diff line change
Expand Up @@ -401,7 +401,7 @@ def get_nodata_mask(
) -> np.ndarray:
"""
.. deprecated:: 1.36.0
Use :py:mod:`rasters_rio.get_data_mask` instead.
Use :py:func:`rasters_rio.get_data_mask` instead.
"""
logs.deprecation_warning("This function is deprecated. Use 'get_data_mask' instead")
return get_data_mask(array, has_nodata, default_nodata)
Expand Down

0 comments on commit 0e1584d

Please sign in to comment.