Misleading documentation on `extract` function in `scikeo.process`

[KBodolai]

ping openjournals/joss-reviews#6692

The documentation for the extract function states that it extracts raster values using a shapefile.

According to the docs it says it takes an image (rasterio.io.DatasetReader) and a shp (Vector file, typically shapefile.). However, the function only works with point geometries, and not general vector data. I think the function could be modified to work with more geometries, like polygons, but at the very least the fact that it only works with points should be in the documentation, and probably there should be a check in the code that alerts the user.

The links to the source code in the docs are also broken, when I click the source button in the top right of the screenshot below, it returns a 404 error.

Additionally, as a nit, I'd change the description to say 'vector file' instead of shapefile, since it is more general than that.

[yotarazona]

Hi @KBodolai, thank you for this feedback!. In the new version of the package a geometry type was add inside the extract(). The function extract() now alerts the user if the input vector is of a type different than point. In addition, the function also alerts if the image and vector projection systems are different, please see https://github.com/yotarazona/scikit-eo/blob/main/scikeo/process.py#L112.

In a future version, a polygon geometry will be added, don't doubt that.