petern48 commented on code in PR #368:
URL: https://github.com/apache/sedona-db/pull/368#discussion_r2565556763
##########
docs/reference/sql.md:
##########
@@ -110,12 +111,38 @@ Return the Well-Known Text string representation of a
geometry or geography.
SELECT ST_AsText(ST_Point(1.0, 2.0))
```
+## ST_Azimuth
+
+Introduction: Returns Azimuth for two given points in radians null otherwise.
+
+Format: ST_Azimuth(pointA: Point, pointB: Point)
+
+Since: v0.2.
+
+```sql
+SELECT ST_Azimuth(ST_POINT(0.0, 25.0), ST_POINT(0.0, 0.0))
+```
+
+## ST_Boundary
+
+Returns the closure of the combinatorial boundary of this Geometry.
+
+Format: `ST_Boundary(geom: Geometry)`
+
+Since: v0.2.
+
+```sql
+SELECT ST_Boundary(ST_GeomFromWKT('POLYGON((1 1,0 0, -1 1, 1 1))'))
+```
+
## ST_Buffer
#### Description
Returns a geometry that represents all points whose distance from the input
geometry is less than or equal to a specified distance.
+Since: v0.1.
Review Comment:
```suggestion
Returns a geometry that represents all points whose distance from the input
geometry is less than or equal to a specified distance.
Since: v0.1.
Changed in version v0.2: Support buffer parameters argument
```
Something that might be easy to miss is that we added support for buffer
params: https://github.com/apache/sedona-db/pull/241
I always appreciate docs that mention versions when functions were added or
received notable updates. More effort on us, but super helpful for developers.
Pyspark does "versionchanged" along w/ a short comment like this
[example](https://spark.apache.org/docs/latest/api/python/reference/pyspark.sql/api/pyspark.sql.DataFrame.html).
I proposed a similar way to do it in the suggestion, but feel free to modify.
Here's a helpful docstring for updating the rest of the buffer docs
https://github.com/apache/sedona-db/blob/79cada0cae30b63ffd26592d8f671adf169fbe2a/c/sedona-geos/src/st_buffer.rs#L37-L47
--
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: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
