Skip to content

Commit

Permalink
Revert "[DOCS] Enable markdownlint rule MD031 (#1331)"
Browse files Browse the repository at this point in the history
This reverts commit 9eca254.
  • Loading branch information
jiayuasu committed Apr 28, 2024
1 parent 5211b31 commit 8bd39cd
Show file tree
Hide file tree
Showing 33 changed files with 3 additions and 248 deletions.
3 changes: 3 additions & 0 deletions .github/linters/.markdown-lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,9 @@ 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: 0 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,6 @@ 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 @@ -123,7 +122,6 @@ 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: 0 additions & 4 deletions docs/api/flink/Constructor.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ Format:
Since: `v1.5.0`

Example:

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

Example:

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

Example:

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

Example:

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

Output:

```
1.7320508075688772
```
Expand All @@ -66,15 +65,13 @@ 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 @@ -225,7 +222,6 @@ SELECT ST_Area(ST_GeomFromText("POLYGON(0 0, 0 10, 10 10, 0 10, 0 0)"))
```

Output:

```
10
```
Expand Down Expand Up @@ -313,7 +309,6 @@ 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 @@ -357,7 +352,6 @@ 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 @@ -513,7 +507,6 @@ Format: `ST_BoundingDiagonal(geom: Geometry)`
Since: `v1.5.0`

Example:

```sql
SELECT ST_BoundingDiagonal(ST_GeomFromWKT(geom))
```
Expand Down Expand Up @@ -606,7 +599,6 @@ 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 @@ -627,7 +619,6 @@ 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 @@ -966,7 +957,6 @@ 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 @@ -1221,13 +1211,11 @@ 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 @@ -1285,13 +1273,11 @@ 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 @@ -1334,13 +1320,11 @@ 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 @@ -1363,13 +1347,11 @@ 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 @@ -1389,13 +1371,11 @@ Format: `ST_H3ToGeom(cells: Array[Long])`
Since: `v1.5.0`

Example:

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

Output:

```
|st_h3togeom(st_h3cellids(st_geomfromwkt(POINT(1 2), 0), 8, true)) |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Expand Down Expand Up @@ -1614,11 +1594,9 @@ 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 @@ -1645,11 +1623,9 @@ 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 @@ -1768,7 +1744,6 @@ SELECT ST_LineInterpolatePoint(ST_GeomFromWKT('LINESTRING(25 50, 100 125, 150 19
```

Output:

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

Output:

```
0.5
```
Expand All @@ -1806,7 +1780,6 @@ 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 @@ -1920,7 +1893,6 @@ WITH linestring AS (
```

Result:

```
+------------------+------------------------+
|st_makevalid(geom)|st_makevalid(geom, true)|
Expand Down Expand Up @@ -2253,7 +2225,6 @@ 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 @@ -2370,7 +2341,6 @@ SRID=3021;POLYGON ((1 1, 8 1, 8 8, 1 8, 1 1))

## ST_SRID


Introduction: Return the spatial reference system identifier (SRID) of the geometry.

Format: `ST_SRID (A: Geometry)`
Expand Down Expand Up @@ -2439,14 +2409,12 @@ 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 @@ -2473,7 +2441,6 @@ 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 @@ -2799,7 +2766,6 @@ 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: 0 additions & 1 deletion docs/api/snowflake/vector-data/Constructor.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ 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 8bd39cd

Please sign in to comment.