You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@sedona.apache.org by "jiayuasu (via GitHub)" <gi...@apache.org> on 2026/10/20 01:27:45 UTC
[I] DataFrame API docstrings leave parameters undocumented or describe the wrong ones [sedona]
jiayuasu opened a new issue, #3488:
URL: https://github.com/apache/sedona/issues/3488
Forty functions in `python/sedona/spark/sql/st_functions.py` and `st_constructors.py` have parameters with no description, which `help()` and generated API references show as blank:
- empty `:param x:` lines, as in `ST_Affine`, `ST_FrechetDistance`, `ST_HausdorffDistance`, `ST_LocateAlong`, `ST_LongestLine` and `ST_MaxDistance`;
- `@param` lines, which Sphinx does not read, as in `ST_DBSCAN`, `ST_GLocal`, `ST_LocalOutlierFactor`, `ST_Perimeter`, `ST_Project`, `ST_RotateX` and `ST_Scale`;
- parameters added later without a description, such as `srid` in the WKT constructors, `type` in `ST_AsGeoJSON` and `useSpheroid` in `ST_Buffer`.
Several docstrings also describe the wrong parameters or behavior:
- `ST_H3CellDistance` documents `cell` and `k` (the parameters are `cell1` and `cell2`), and its summary describes covering a geometry with cells.
- `ST_M` documents `point`, and `ST_MMax` and `ST_MMin` document `geometry`; the parameter is `geom`. `ST_MMax` says it returns the minimum.
- `ST_PointM` documents a `z` parameter instead of `m`.
- `ST_GeneratePoints` describes its parameters as a geohash column and precision.
- `ST_SimplifyPolygonHull` describes Visvalingam-Whyatt simplification and calls `vertexFactor` a tolerance.
--
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] DataFrame API docstrings leave parameters undocumented or describe the wrong ones [sedona]
Posted by "jiayuasu (via GitHub)" <gi...@apache.org>.
jiayuasu closed issue #3488: DataFrame API docstrings leave parameters undocumented or describe the wrong ones
URL: https://github.com/apache/sedona/issues/3488
--
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