This is an automated email from the ASF dual-hosted git repository.
jiayu pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/sedona.git
The following commit(s) were added to refs/heads/master by this push:
new 6a69b494d [DOCS] Fix spelling (#998)
6a69b494d is described below
commit 6a69b494d0b35710b2c07b70dcb4f8c7e73c2525
Author: John Bampton <[email protected]>
AuthorDate: Wed Sep 6 01:58:11 2023 +1000
[DOCS] Fix spelling (#998)
---
docs/api/flink/Function.md | 12 ++++++------
docs/api/sql/Function.md | 8 ++++----
docs/api/sql/Optimizer.md | 6 +++---
docs/api/sql/Raster-writer.md | 2 +-
4 files changed, 14 insertions(+), 14 deletions(-)
diff --git a/docs/api/flink/Function.md b/docs/api/flink/Function.md
index 259acd8ae..ba34e5d6c 100644
--- a/docs/api/flink/Function.md
+++ b/docs/api/flink/Function.md
@@ -297,7 +297,7 @@ EWKT is an extended version of WKT which includes the SRID
of the geometry.
The format originated in PostGIS but is supported by many GIS tools.
If the geometry is lacking SRID a WKT format is produced.
[See ST_SetSRID](#ST_SetSRID)
-It will support M coodinate if present since v1.5.0.
+It will support M coordinate if present since v1.5.0.
Format: `ST_AsEWKT (A:geometry)`
@@ -409,7 +409,7 @@ Output:
## ST_AsText
Introduction: Return the Well-Known Text string representation of a geometry.
-It will support M coodinate if present since v1.5.0.
+It will support M coordinate if present since v1.5.0.
Format: `ST_AsText (A:geometry)`
@@ -581,7 +581,7 @@ POINT (4.8 4.8)
Introduction: Returns the 2-dimensional point on geom1 that is closest to
geom2. This is the first point of the shortest line between the geometries. If
using 3D geometries, the Z coordinates will be ignored. If you have a 3D
Geometry, you may prefer to use ST_3DClosestPoint.
It will throw an exception indicates illegal argument if one of the params is
an empty geometry.
-Format: `ST_ClosestPoint(g1: geomtry, g2: geometry)`
+Format: `ST_ClosestPoint(g1: geometry, g2: geometry)`
Since: `1.5.0`
@@ -717,7 +717,7 @@ POLYGON ((125 100, 20 40, 50 60, 175 150, 125 100))
```
## ST_ConvexHull
-Introduction: Return the Convex Hull of polgyon A
+Introduction: Return the Convex Hull of polygon A
Format: `ST_ConvexHull (A:geometry)`
@@ -1105,7 +1105,7 @@ based on [Computing Discrete Frechet
Distance](http://www.kr.tuwien.ac.at/staff/
If any of the geometries is empty, returns 0.0
-Format: `ST_FrechetDistance(g1: geomtry, g2: geometry)`
+Format: `ST_FrechetDistance(g1: geometry, g2: geometry)`
Since: `1.5.0`
@@ -1624,7 +1624,7 @@ POLYGON ((7 -1, 7 6, 9 6, 9 1, 7 -1), (6 2, 8 2, 8 1, 6
1, 6 2))
Introduction: Given an invalid geometry, create a valid representation of the
geometry.
-Collapsed geometries are either converted to empty (keepCollaped=true) or a
valid geometry of lower dimension (keepCollapsed=false).
+Collapsed geometries are either converted to empty (keepCollapsed=true) or a
valid geometry of lower dimension (keepCollapsed=false).
Default is keepCollapsed=false.
Format: `ST_MakeValid (A:geometry)`
diff --git a/docs/api/sql/Function.md b/docs/api/sql/Function.md
index b00a829fe..5873338ab 100644
--- a/docs/api/sql/Function.md
+++ b/docs/api/sql/Function.md
@@ -292,7 +292,7 @@ EWKT is an extended version of WKT which includes the SRID
of the geometry.
The format originated in PostGIS but is supported by many GIS tools.
If the geometry is lacking SRID a WKT format is produced.
[See ST_SetSRID](#ST_SetSRID)
-It will support M coodinate if present since v1.5.0.
+It will support M coordinate if present since v1.5.0.
Format: `ST_AsEWKT (A:geometry)`
@@ -406,7 +406,7 @@ Output:
## ST_AsText
Introduction: Return the Well-Known Text string representation of a geometry.
-It will support M coodinate if present since v1.5.0.
+It will support M coordinate if present since v1.5.0.
Format: `ST_AsText (A:geometry)`
@@ -587,7 +587,7 @@ POINT (4.8 4.8)
Introduction: Returns the 2-dimensional point on geom1 that is closest to
geom2. This is the first point of the shortest line between the geometries. If
using 3D geometries, the Z coordinates will be ignored. If you have a 3D
Geometry, you may prefer to use ST_3DClosestPoint.
It will throw an exception indicates illegal argument if one of the params is
an empty geometry.
-Format: `ST_ClosestPoint(g1: geomtry, g2: geometry)`
+Format: `ST_ClosestPoint(g1: geometry, g2: geometry)`
Since: `1.5.0`
@@ -1114,7 +1114,7 @@ based on [Computing Discrete Frechet
Distance](http://www.kr.tuwien.ac.at/staff/
If any of the geometries is empty, returns 0.0
-Format: `ST_FrechetDistance(g1: geomtry, g2: geometry)`
+Format: `ST_FrechetDistance(g1: geometry, g2: geometry)`
Since: `1.5.0`
diff --git a/docs/api/sql/Optimizer.md b/docs/api/sql/Optimizer.md
index d96bcaee8..767ca5f36 100644
--- a/docs/api/sql/Optimizer.md
+++ b/docs/api/sql/Optimizer.md
@@ -169,9 +169,9 @@ BroadcastIndexJoin pointshape#52: geometry, BuildRight,
BuildLeft, true, 2.0 ST_
Note: If the distance is an expression, it is only evaluated on the first
argument to ST_Distance (`pointDf1` above).
-## Auotmatic broadcast index join
+## Automatic broadcast index join
-When one table involved a spatial join query is smaller than a threadhold,
Sedona will automatically choose broadcast index join instead of Sedona
optimized join. The current threshold is controlled by
[sedona.join.autoBroadcastJoinThreshold](../Parameter) and set to the same as
`spark.sql.autoBroadcastJoinThreshold`.
+When one table involved a spatial join query is smaller than a threshold,
Sedona will automatically choose broadcast index join instead of Sedona
optimized join. The current threshold is controlled by
[sedona.join.autoBroadcastJoinThreshold](../Parameter) and set to the same as
`spark.sql.autoBroadcastJoinThreshold`.
## Raster join
@@ -244,7 +244,7 @@ As you see, compared to the query in Step 2, we added one
more filter, which is
!!!tip
You can skip this step if you don't need 100% accuracy and want faster
query speed.
-### 4. Optional: De-duplcate
+### 4. Optional: De-duplicate
Due to the explode function used when we generate S2 Cell Ids, the resulting
DataFrame may have several duplicate <lcs_geom, rcs_geom> matches. You can
remove them by performing a GroupBy query.
diff --git a/docs/api/sql/Raster-writer.md b/docs/api/sql/Raster-writer.md
index 445eb3fdf..aaea7951c 100644
--- a/docs/api/sql/Raster-writer.md
+++ b/docs/api/sql/Raster-writer.md
@@ -128,7 +128,7 @@ Available options:
* Default value: `.tiff`
* Allowed values: any string values such as `.png`, `.jpeg`, `.asc`
* pathField
- * No defaulut value. If you use this option, then the column specified
in this option must exist in the DataFrame schema. If this option is not used,
each produced raster image will have a random UUID file name.
+ * No default value. If you use this option, then the column specified
in this option must exist in the DataFrame schema. If this option is not used,
each produced raster image will have a random UUID file name.
* Allowed values: any column name that indicates the paths of each
raster file
The schema of the Raster dataframe to be written can be one of the following
two schemas: