Skip to content

Commit

Permalink
Incremental commit on PR
Browse files Browse the repository at this point in the history
  • Loading branch information
rhugonnet committed Feb 27, 2024
1 parent 112fc6b commit ae028f5
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 8 deletions.
9 changes: 3 additions & 6 deletions doc/source/dem_class.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,11 @@ Below, a summary of the {class}`~xdem.DEM` object and its methods.
## Object definition and attributes

A {class}`~xdem.DEM` is a {class}`~geoutils.Raster` with an additional georeferenced vertical dimension stored in the attribute {attr}`~xdem.DEM.vcrs`.
It inherits the **four main attributes** of {class}`~geoutils.Raster` which are {attr}`~xdem.DEM.data`,
It inherits the **four main attributes** of {class}`~geoutils.Raster` which are {attr}`~xdem.DEM.data`,
{attr}`~xdem.DEM.transform`, {attr}`~xdem.DEM.crs` and {attr}`~xdem.DEM.nodata`.

Many other useful raster attributes, such as {attr}`~xdem.DEM.bounds` and {attr}`~xdem.DEM.res` and raster methods
such {attr}`~xdem.DEM.reproject` or {attr}`~xdem.DEM.crop` are available through the {class}`~geoutils.Raster` object.
Many other useful raster attributes, such as {attr}`~xdem.DEM.bounds` and {attr}`~xdem.DEM.res` and raster methods
such {attr}`~xdem.DEM.reproject` or {attr}`~xdem.DEM.crop` are available through the {class}`~geoutils.Raster` object.

```{important}
Below, we only cover a few core aspects linked to the {class}`~geoutils.Raster` object. For more details, see [GeoUtils' Raster documentation page](https://geoutils.readthedocs.io/en/stable/raster_class.html).
Expand Down Expand Up @@ -69,6 +69,3 @@ dem.save("mydem.tif")
import os
os.remove("mydem.tif")
```



2 changes: 1 addition & 1 deletion doc/source/elevation_objects.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
(elevation-objects)=
# Elevation data objects

Elevation data objects of xDEM inherit their characteristics from raster and vector objects of
Elevation data objects of xDEM inherit their characteristics from raster and vector objects of
our sister-package [GeoUtils](https://geoutils.readthedocs.io/en/stable/).

```{toctree}
Expand Down
2 changes: 1 addition & 1 deletion doc/source/elevation_point_cloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@ kernelspec:

# The elevation point cloud ({class}`~xdem.EPC`)

In construction, planned for 2024.
In construction, planned for 2024.
3 changes: 3 additions & 0 deletions xdem/misc.py
Original file line number Diff line number Diff line change
Expand Up @@ -168,6 +168,9 @@ def decorator(decorated: Callable) -> Callable: # type: ignore
)
other_doc = other_doc.replace(resolution_section, "")

# Remove docstring examples
other_doc = other_doc.split(":examples:")[0]

decorated.__doc__ = other_doc

return decorated
Expand Down

0 comments on commit ae028f5

Please sign in to comment.