This is an automated email from the ASF dual-hosted git repository.
jiayu pushed a commit to branch issue-2679-doc-return-types
in repository https://gitbox.apache.org/repos/asf/sedona.git
The following commit(s) were added to refs/heads/issue-2679-doc-return-types by
this push:
new 6255498fb4 Wrap remaining bare Array<> types in backtick code spans in
summary tables
6255498fb4 is described below
commit 6255498fb471c4014df36103c25b5347be855d9f
Author: Jia Yu <[email protected]>
AuthorDate: Wed Mar 4 00:11:48 2026 -0800
Wrap remaining bare Array<> types in backtick code spans in summary tables
---
docs/api/flink/Geometry-Functions.md | 2 +-
docs/api/sql/Geometry-Functions.md | 6 +++---
docs/api/sql/Raster-Functions.md | 6 +++---
3 files changed, 7 insertions(+), 7 deletions(-)
diff --git a/docs/api/flink/Geometry-Functions.md
b/docs/api/flink/Geometry-Functions.md
index 70621127b3..b3569bef02 100644
--- a/docs/api/flink/Geometry-Functions.md
+++ b/docs/api/flink/Geometry-Functions.md
@@ -241,7 +241,7 @@ These functions compute results arising from the overlay of
two geometries. Thes
| :--- | :--- | :--- | :--- |
| [ST_Difference](Overlay-Functions/ST_Difference.md) | Geometry | Return the
difference between geometry A and B (return part of geometry A that does not
intersect geometry B) | v1.5.0 |
| [ST_Intersection](Overlay-Functions/ST_Intersection.md) | Geometry | Return
the intersection geometry of A and B | v1.5.0 |
-| [ST_SubDivide](Overlay-Functions/ST_SubDivide.md) | Array<Geometry> |
Returns list of geometries divided based of given maximum number of vertices. |
v1.5.0 |
+| [ST_SubDivide](Overlay-Functions/ST_SubDivide.md) | `Array<Geometry>` |
Returns list of geometries divided based of given maximum number of vertices. |
v1.5.0 |
| [ST_SymDifference](Overlay-Functions/ST_SymDifference.md) | Geometry |
Return the symmetrical difference between geometry A and B (return parts of
geometries which are in either of the sets, but not in their intersection) |
v1.5.0 |
| [ST_UnaryUnion](Overlay-Functions/ST_UnaryUnion.md) | Geometry | This
variant of [ST_Union](Overlay-Functions/ST_Union.md) operates on a single
geometry input. The input geometry can be a simple Geometry type, a
MultiGeometry, or a GeometryCollection. The function calculates the ge... |
v1.6.1 |
| [ST_Union](Overlay-Functions/ST_Union.md) | Geometry | Variant 1: Return the
union of geometry A and B. | v1.6.0 |
diff --git a/docs/api/sql/Geometry-Functions.md
b/docs/api/sql/Geometry-Functions.md
index 1369f9a883..edb2e049fd 100644
--- a/docs/api/sql/Geometry-Functions.md
+++ b/docs/api/sql/Geometry-Functions.md
@@ -244,7 +244,7 @@ These functions compute results arising from the overlay of
two geometries. Thes
| [ST_Difference](Overlay-Functions/ST_Difference.md) | Geometry | Return the
difference between geometry A and B (return part of geometry A that does not
intersect geometry B) | v1.2.0 |
| [ST_Intersection](Overlay-Functions/ST_Intersection.md) | Geometry | Return
the intersection geometry of A and B | v1.0.0 |
| [ST_Split](Overlay-Functions/ST_Split.md) | Geometry | Split an input
geometry by another geometry (called the blade). Linear (LineString or
MultiLineString) geometry can be split by a Point, MultiPoint, LineString,
MultiLineString, Polygon, or MultiPo... | v1.4.0 |
-| [ST_SubDivide](Overlay-Functions/ST_SubDivide.md) | Array<Geometry> |
Returns list of geometries divided based of given maximum number of vertices. |
v1.1.0 |
+| [ST_SubDivide](Overlay-Functions/ST_SubDivide.md) | `Array<Geometry>` |
Returns list of geometries divided based of given maximum number of vertices. |
v1.1.0 |
| [ST_SubDivideExplode](Overlay-Functions/ST_SubDivideExplode.md) | Geometry |
It works the same as ST_SubDivide but returns new rows with geometries instead
of list. | v1.1.0 |
| [ST_SymDifference](Overlay-Functions/ST_SymDifference.md) | Geometry |
Return the symmetrical difference between geometry A and B (return parts of
geometries which are in either of the sets, but not in their intersection) |
v1.2.0 |
| [ST_UnaryUnion](Overlay-Functions/ST_UnaryUnion.md) | Geometry | This
variant of [ST_Union](Overlay-Functions/ST_Union.md) operates on a single
geometry input. The input geometry can be a simple Geometry type, a
MultiGeometry, or a GeometryCollection. The function calculates the ge... |
v1.6.1 |
@@ -378,5 +378,5 @@ These functions parse and expand street addresses using the
libpostal library.
| Function | Return type | Description | Since |
| :--- | :--- | :--- | :--- |
-| [ExpandAddress](Address-Functions/ExpandAddress.md) | Array<String> |
Returns an array of expanded forms of the input address string. This is backed
by the [libpostal](https://github.com/openvenues/libpostal) library's address
expanding functionality. | v1.8.0 |
-| [ParseAddress](Address-Functions/ParseAddress.md) | Array<Struct> | Returns
an array of the components (e.g. street, postal code) of the input address
string. This is backed by the
[libpostal](https://github.com/openvenues/libpostal) library's address parsing
funct... | v1.8.0 |
+| [ExpandAddress](Address-Functions/ExpandAddress.md) | `Array<String>` |
Returns an array of expanded forms of the input address string. This is backed
by the [libpostal](https://github.com/openvenues/libpostal) library's address
expanding functionality. | v1.8.0 |
+| [ParseAddress](Address-Functions/ParseAddress.md) | `Array<Struct>` |
Returns an array of the components (e.g. street, postal code) of the input
address string. This is backed by the
[libpostal](https://github.com/openvenues/libpostal) library's address parsing
funct... | v1.8.0 |
diff --git a/docs/api/sql/Raster-Functions.md b/docs/api/sql/Raster-Functions.md
index e42193edf9..6c1e6ffb38 100644
--- a/docs/api/sql/Raster-Functions.md
+++ b/docs/api/sql/Raster-Functions.md
@@ -39,11 +39,11 @@ These functions work with individual pixel geometry
representations.
| Function | Return type | Description | Since |
| :--- | :--- | :--- | :--- |
| [RS_PixelAsCentroid](Pixel-Functions/RS_PixelAsCentroid.md) | Geometry |
Returns the centroid (point geometry) of the specified pixel's area. The pixel
coordinates specified are 1-indexed. If `colX` and `rowY` are out of bounds for
the raster, they are interpolated assu... | v1.5.0 |
-| [RS_PixelAsCentroids](Pixel-Functions/RS_PixelAsCentroids.md) |
Array<Struct> | Returns a list of the centroid point geometry, the pixel value
and its raster X and Y coordinates for each pixel in the raster at the
specified band. Each centroid represents the geometric center o... | v1.5.1 |
+| [RS_PixelAsCentroids](Pixel-Functions/RS_PixelAsCentroids.md) |
`Array<Struct>` | Returns a list of the centroid point geometry, the pixel
value and its raster X and Y coordinates for each pixel in the raster at the
specified band. Each centroid represents the geometric center o... | v1.5.1 |
| [RS_PixelAsPoint](Pixel-Functions/RS_PixelAsPoint.md) | Geometry | Returns a
point geometry of the specified pixel's upper-left corner. The pixel
coordinates specified are 1-indexed. | v1.5.0 |
-| [RS_PixelAsPoints](Pixel-Functions/RS_PixelAsPoints.md) | Array<Struct> |
Returns a list of the pixel's upper-left corner point geometry, the pixel value
and its raster X and Y coordinates for each pixel in the raster at the
specified band. | v1.5.1 |
+| [RS_PixelAsPoints](Pixel-Functions/RS_PixelAsPoints.md) | `Array<Struct>` |
Returns a list of the pixel's upper-left corner point geometry, the pixel value
and its raster X and Y coordinates for each pixel in the raster at the
specified band. | v1.5.1 |
| [RS_PixelAsPolygon](Pixel-Functions/RS_PixelAsPolygon.md) | Geometry |
Returns a polygon geometry that bounds the specified pixel. The pixel
coordinates specified are 1-indexed. If `colX` and `rowY` are out of bounds for
the raster, they are interpolated assuming the ... | v1.5.0 |
-| [RS_PixelAsPolygons](Pixel-Functions/RS_PixelAsPolygons.md) | Array<Struct>
| Returns a list of the polygon geometry, the pixel value and its raster X and
Y coordinates for each pixel in the raster at the specified band. | v1.5.1 |
+| [RS_PixelAsPolygons](Pixel-Functions/RS_PixelAsPolygons.md) |
`Array<Struct>` | Returns a list of the polygon geometry, the pixel value and
its raster X and Y coordinates for each pixel in the raster at the specified
band. | v1.5.1 |
## Raster Geometry Functions
