[I] Raster, type, map and GeoArrow Python APIs lack docstrings or parameter docs [sedona]

["jiayuasu (via GitHub)" <gi...@apache.org>]

jiayuasu opened a new issue, #3493:
URL: https://github.com/apache/sedona/issues/3493

   Several public Python classes and functions have no docstring or leave parameters undocumented, so `help()` and generated API references show little or nothing for them:
   
   - `sedona.spark.sql.types`: `GeometryType`, `GeographyType`, `Box2DType`, `Box3DType` and `RasterType` have no docstring, so nothing says which Python objects their column values become.
   - `sedona.spark.raster`: the `SedonaRaster` class has no docstring and its constructor parameters are undocumented; `with_bands` documents neither parameter. In `sedona.spark.raster.meta`, `AffineTransform`, `AffineTransform.with_anchor` and `AffineTransform.translate` have no docstring, and the `SampleDimension` fields are undocumented.
   - `sedona.spark.geoarrow.create_spatial_dataframe` has no docstring, and `dataframe_to_arrow` has an empty `:return:`.
   - `SedonaKepler` and `SedonaPyDeck` have no class docstring. `SedonaKepler.create_map` writes four of its parameters as `param config:` without the leading colon, so they are not read as fields. `SedonaPyDeck.create_geometry_map` and `create_scatterplot_map` have empty `:param line_color:`, `:param radius_col:`, `:param radius_min_pixels:`, `:param radius_max_pixels:` and `:param radius_scale:` lines, and `stroked` is not documented.
   - `SedonaUtils` has no class docstring, and `display_image` does not document `df`.
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@sedona.apache.org.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

Re: [I] Raster, type, map and GeoArrow Python APIs lack docstrings or parameter docs [sedona]

["jiayuasu (via GitHub)" <gi...@apache.org>]

jiayuasu closed issue #3493: Raster, type, map and GeoArrow Python APIs lack docstrings or parameter docs
URL: https://github.com/apache/sedona/issues/3493


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@sedona.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org