Skip to content

Conversation

@MrPowers
Copy link
Collaborator

This PR adds API docs for the SQL functions that are added in v0.2.

I still need to get the library setup locally and double-check all the code snippets. Also need to add some more functions.

Comment on lines 142 to +144
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.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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.
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: #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. 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

/// Supports two signatures:
/// - ST_Buffer(geometry: Geometry, distance: Double)
/// - ST_Buffer(geometry: Geometry, distance: Double, bufferStyleParameters: String)
///
/// Buffer style parameters format: "key1=value1 key2=value2 ..."
/// Supported parameters:
/// - endcap: round, flat/butt, square
/// - join: round, mitre/miter, bevel
/// - side: both, left, right
/// - mitre_limit/miter_limit: numeric value
/// - quad_segs/quadrant_segments: integer value

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good call, I like "changed in version..."!


#### Description

Construct a Geometry from WKT. This function also has the alias **ST_GeomFromText**.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Construct a Geometry from WKT. This function also has the alias **ST_GeomFromText**.
Construct a Geometry from WKT. This function also has the aliases **ST_GeomFromText** and ** ST_GeometryFromText**

Another thing easy to miss: new alias #213

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants