Skip to content

Commit

Permalink
[DOCS] Enable markdownlint rule MD031 (#1331)
Browse files Browse the repository at this point in the history
https://github.com/DavidAnson/markdownlint/blob/main/doc/md031.md

"Rationale: Aside from aesthetic reasons, some parsers, including kramdown, will not parse fenced code blocks that don't have blank lines before and after them."
  • Loading branch information
jbampton committed Apr 11, 2024
1 parent c18ede0 commit ca0b075
Show file tree
Hide file tree
Showing 37 changed files with 296 additions and 3 deletions.
3 changes: 0 additions & 3 deletions .github/linters/.markdown-lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,6 @@ MD026: false
# ol-prefix - Ordered list item prefix
MD029: false

# blanks-around-fences - Fenced code blocks should be surrounded by blank lines
MD031: false

# blanks-around-lists - Lists should be surrounded by blank lines
MD032: false

Expand Down
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,7 @@ This example loads NYC taxi trip records and taxi zone information stored as .CS
taxidf = sedona.read.format('csv').option("header","true").option("delimiter", ",").load("s3a://your-directory/data/nyc-taxi-data.csv")
taxidf = taxidf.selectExpr('ST_Point(CAST(Start_Lon AS Decimal(24,20)), CAST(Start_Lat AS Decimal(24,20))) AS pickup', 'Trip_Pickup_DateTime', 'Payment_Type', 'Fare_Amt')
```

```python
zoneDf = sedona.read.format('csv').option("delimiter", ",").load("s3a://your-directory/data/TIGER2018_ZCTA5.csv")
zoneDf = zoneDf.selectExpr('ST_GeomFromWKT(_c0) as zone', '_c1 as zipcode')
Expand Down Expand Up @@ -122,6 +123,7 @@ We provide a Docker image for Apache Sedona with Python JupyterLab and a single-
```
pip install apache-sedona
```

* To compile the source code, please refer to [Sedona website](https://sedona.apache.org/latest-snapshot/setup/compile/)

* Modules in the source code
Expand Down
4 changes: 4 additions & 0 deletions docs/api/flink/Constructor.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ Format:
Since: `v1.5.0`

Example:

```sql
SELECT ST_AsText(ST_GeomFromEWKT('SRID=4269;POINT(40.7128 -74.0060)'))
```
Expand Down Expand Up @@ -227,6 +228,7 @@ Format:
Since: `v1.2.1`

Example:

```sql
SELECT ST_GeomFromWKB(polygontable._c0) AS polygonshape
FROM polygontable
Expand All @@ -242,6 +244,7 @@ Format:
Since: `v1.2.0`

Example:

```sql
SELECT ST_GeomFromWKT('POINT(40.7128 -74.0060)')
```
Expand All @@ -261,6 +264,7 @@ Format: `ST_LineFromText (Text: String)`
Since: `v1.2.1`

Example:

```sql
SELECT ST_LineFromText('Linestring(1 2, 3 4)')
```
Expand Down
37 changes: 37 additions & 0 deletions docs/api/flink/Function.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ SELECT ST_3DDistance(ST_GeomFromText("POINT Z (0 0 -5)"),
```

Output:

```
1.7320508075688772
```
Expand All @@ -65,13 +66,15 @@ Format:
Since: `v1.3.0`

Example:

```sql
SELECT ST_AddPoint(ST_GeomFromText("LINESTRING(0 0, 1 1, 1 0)"), ST_GeomFromText("Point(21 52)"), 1)

SELECT ST_AddPoint(ST_GeomFromText("Linestring(0 0, 1 1, 1 0)"), ST_GeomFromText("Point(21 52)"))
```

Output:

```
LINESTRING(0 0, 21 52, 1 1, 1 0)
LINESTRING(0 0, 1 1, 1 0, 21 52)
Expand Down Expand Up @@ -222,6 +225,7 @@ SELECT ST_Area(ST_GeomFromText("POLYGON(0 0, 0 10, 10 10, 0 10, 0 0)"))
```

Output:

```
10
```
Expand Down Expand Up @@ -309,6 +313,7 @@ Format: `ST_AsEWKT (A: Geometry)`
Since: `v1.2.1`

Example:

```sql
SELECT ST_AsEWKT(ST_SetSrid(ST_GeomFromWKT('POLYGON((0 0,0 1,1 1,1 0,0 0))'), 4326))
```
Expand Down Expand Up @@ -352,6 +357,7 @@ Format: `ST_AsGeoJSON (A: Geometry)`
Since: `v1.3.0`

Example:

```sql
SELECT ST_AsGeoJSON(ST_GeomFromWKT('POLYGON((1 1, 8 1, 8 8, 1 8, 1 1))'))
```
Expand Down Expand Up @@ -535,6 +541,7 @@ Format: `ST_BoundingDiagonal(geom: Geometry)`
Since: `v1.5.0`

Example:

```sql
SELECT ST_BoundingDiagonal(ST_GeomFromWKT(geom))
```
Expand Down Expand Up @@ -590,9 +597,11 @@ Format:
```
ST_Buffer (A: Geometry, buffer: Double)
```

```
ST_Buffer (A: Geometry, buffer: Double, useSpheroid: Boolean)
```

```
ST_Buffer (A: Geometry, buffer: Double, useSpheroid: Boolean, bufferStyleParameters: String)
```
Expand Down Expand Up @@ -654,6 +663,7 @@ Format: `ST_Centroid (A: Geometry)`
Since: `v1.5.0`

Example:

```sql
SELECT ST_Centroid(ST_GeomFromWKT('MULTIPOINT(-1 0, -1 2, 7 8, 9 8, 10 6)'))
```
Expand All @@ -674,6 +684,7 @@ Format: `ST_ClosestPoint(g1: Geometry, g2: Geometry)`
Since: `v1.5.0`

Example:

```sql
SELECT ST_AsText( ST_ClosestPoint(g1, g2)) As ptwkt;
```
Expand Down Expand Up @@ -1041,6 +1052,7 @@ Format: `ST_Dump(geom: Geometry)`
Since: `v1.5.0`

Example:

```sql
SELECT ST_Dump(ST_GeomFromText('MULTIPOINT ((10 40), (40 30), (20 20), (30 10))'))
```
Expand Down Expand Up @@ -1335,11 +1347,13 @@ Default parameters: `tolerance: 1e-6, maxIter: 1000, failIfNotConverged: false`
Since: `v1.4.1`

Example:

```sql
SELECT ST_GeometricMedian(ST_GeomFromWKT('MULTIPOINT((0 0), (1 1), (2 2), (200 200))'))
```

Output:

```
POINT (1.9761550281255005 1.9761550281255005)
```
Expand Down Expand Up @@ -1397,11 +1411,13 @@ Format: `ST_H3CellDistance(cell1: Long, cell2: Long)`
Since: `v1.5.0`

Example:

```sql
select ST_H3CellDistance(ST_H3CellIDs(ST_GeomFromWKT('POINT(1 2)'), 8, true)[1], ST_H3CellIDs(ST_GeomFromWKT('POINT(1.23 1.59)'), 8, true)[1])
```

Output:

```
+----+----------------------+
| op | EXPR$0 |
Expand Down Expand Up @@ -1444,11 +1460,13 @@ Format: `ST_H3CellIDs(geom: geometry, level: Int, fullCover: true)`
Since: `v1.5.0`

Example:

```sql
SELECT ST_H3CellIDs(ST_GeomFromText('LINESTRING(1 3 4, 5 6 7)'), 6, true)
```

Output:

```
+----+--------------------------------+
| op | EXPR$0 |
Expand All @@ -1471,11 +1489,13 @@ Format: `ST_H3KRing(cell: Long, k: Int, exactRing: Boolean)`
Since: `v1.5.0`

Example:

```sql
select ST_H3KRing(ST_H3CellIDs(ST_GeomFromWKT('POINT(1 2)'), 8, true)[1], 1, false), ST_H3KRing(ST_H3CellIDs(ST_GeomFromWKT('POINT(1 2)'), 8, true)[1], 1, true)
```

Output:

```
+----+--------------------------------+--------------------------------+
| op | EXPR$0 | EXPR$1 |
Expand All @@ -1500,11 +1520,13 @@ Format: `ST_H3ToGeom(cells: Array[Long])`
Since: `v1.6.0`

Example:

```sql
SELECT ST_H3ToGeom(ST_H3CellIDs(ST_GeomFromWKT('POINT(1 2)'), 8, true)[0], 1, true))
```

Output:

```
[POLYGON ((1.0057629565405093 1.9984665139177547, 1.0037116327309097 2.0018325249140068, 0.999727799357053 2.001163270465665, 0.9977951427833316 1.997128228393235, 0.9998461908217928 1.993762152933182, 1.0038301712104316 1.9944311839965523, 1.0057629565405093 1.9984665139177547))]
```
Expand Down Expand Up @@ -1760,9 +1782,11 @@ Introduction: Test if a geometry is well-formed. The function can be invoked wit
- 1: "ESRI flag", Accepts certain self-touching rings as valid, which are considered invalid under OGC standards.

Formats:

```
ST_IsValid (A: Geometry)
```

```
ST_IsValid (A: Geometry, flag: Integer)
```
Expand All @@ -1789,9 +1813,11 @@ Introduction: Returns text stating if the geometry is valid. If not, it provides
- 1: "ESRI flag", Accepts certain self-touching rings as valid, which are considered invalid under OGC standards.

Formats:

```
ST_IsValidReason (A: Geometry)
```

```
ST_IsValidReason (A: Geometry, flag: Integer)
```
Expand Down Expand Up @@ -1910,6 +1936,7 @@ SELECT ST_LineInterpolatePoint(ST_GeomFromWKT('LINESTRING(25 50, 100 125, 150 19
```

Output:

```
POINT (51.5974135047432 76.5974135047432)
```
Expand All @@ -1930,6 +1957,7 @@ SELECT ST_LineLocatePoint(ST_GeomFromWKT('LINESTRING(0 0, 1 1, 2 2)'), ST_GeomFr
```

Output:

```
0.5
```
Expand All @@ -1946,6 +1974,7 @@ Format: `ST_LineMerge (A: Geometry)`
Since: `v1.5.0`

Example:

```sql
SELECT ST_LineMerge(ST_GeomFromWKT('MULTILINESTRING ((-29 -27, -30 -29.7, -45 -33), (-45 -33, -46 -32))'))
```
Expand Down Expand Up @@ -2059,6 +2088,7 @@ WITH linestring AS (
```

Result:

```
+------------------+------------------------+
|st_makevalid(geom)|st_makevalid(geom, true)|
Expand Down Expand Up @@ -2391,6 +2421,7 @@ Example:
SELECT ST_ReducePrecision(ST_GeomFromWKT('Point(0.1234567890123456789 0.1234567890123456789)')
, 9)
```

The new coordinates will only have 9 decimal places.

Output:
Expand Down Expand Up @@ -2542,11 +2573,13 @@ Format: `ST_ShiftLongitude (geom: geometry)`
Since: `v1.6.0`

SQL example:

```SQL
SELECT ST_ShiftLongitude(ST_GeomFromText('LINESTRING(177 10, 179 10, -179 10, -177 10)'))
```

Output:

```sql
LINESTRING(177 10, 179 10, 181 10, 183 10)
```
Expand Down Expand Up @@ -2653,12 +2686,14 @@ Format: `ST_SubDivide(geom: Geometry, maxVertices: Integer)`
Since: `v1.5.0`

Example:

```sql
SELECT ST_SubDivide(ST_GeomFromText("POLYGON((35 10, 45 45, 15 40, 10 20, 35 10), (20 30, 35 35, 30 20, 20 30))"), 5)

```

Output:

```
[
POLYGON((37.857142857142854 20, 35 10, 10 20, 37.857142857142854 20)),
Expand All @@ -2685,6 +2720,7 @@ SELECT ST_SubDivide(ST_GeomFromText("LINESTRING(0 0, 85 85, 100 100, 120 120, 21
```

Output:

```
[
LINESTRING(0 0, 5 5)
Expand Down Expand Up @@ -3055,6 +3091,7 @@ Format: `ST_ZMax(geom: Geometry)`
Since: `v1.3.1`

Example:

```sql
SELECT ST_ZMax(ST_GeomFromText('POLYGON((0 0 1, 1 1 1, 1 2 1, 1 1 1, 0 0 1))'))
```
Expand Down
1 change: 1 addition & 0 deletions docs/api/flink/Predicate.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,7 @@ SELECT ST_DWithin(ST_GeomFromWKT(-122.335167 47.608013), ST_GeomFromWKT(-73.9352
```

Output:

```
true
```
Expand Down
1 change: 1 addition & 0 deletions docs/api/snowflake/vector-data/Constructor.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ Format:
`ST_GeomFromEWKT (EWkt:string)`

SQL example:

```sql
SELECT ST_AsText(ST_GeomFromEWKT('SRID=4269;POINT(40.7128 -74.0060)'))
```
Expand Down
Loading

0 comments on commit ca0b075

Please sign in to comment.