Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
vdelacruzb committed Oct 29, 2024
1 parent 49f441e commit 48296e4
Show file tree
Hide file tree
Showing 26 changed files with 26 additions and 26 deletions.
2 changes: 1 addition & 1 deletion clouds/bigquery/modules/doc/h3/H3_FROMGEOGPOINT.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ H3_FROMGEOGPOINT(point, resolution)

**Description**

Returns the H3 cell index that the point belongs to in the required `resolution`. It will return `null` on error (invalid geography type or resolution out of bounds). This function is an alias for `H3_FROMGEOPOINT`.
Returns the H3 cell index that the point belongs to in the requested `resolution`. It will return `null` on error (invalid geography type or resolution out of bounds). This function is an alias for `H3_FROMGEOPOINT`.

* `point`: `GEOGRAPHY` point to get the H3 cell from.
* `resolution`: `INT64` number between 0 and 15 with the [H3 resolution](https://h3geo.org/docs/core-library/restable).
Expand Down
2 changes: 1 addition & 1 deletion clouds/bigquery/modules/doc/h3/H3_POLYFILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ H3_POLYFILL(geog, resolution)

**Description**

Returns an array of H3 cell indexes contained in the given geography (Polygon, MultiPolygon) at a given level of detail. Containment is determined by the cells' center. This function is equivalent to [`H3_POLYFILL_MODE`](h3#h3_polyfill_mode) with mode `center`.
Returns an array of H3 cell indexes contained in the given geography (Polygon, MultiPolygon) at a requested resolution. Containment is determined by the cells' center. This function is equivalent to [`H3_POLYFILL_MODE`](h3#h3_polyfill_mode) with mode `center`.

* `geog`: `GEOGRAPHY` representing the shape to cover.
* `resolution`: `INT64` level of detail. The value must be between 0 and 15 ([H3 resolution table](https://h3geo.org/docs/core-library/restable)).
Expand Down
2 changes: 1 addition & 1 deletion clouds/bigquery/modules/doc/h3/H3_POLYFILL_MODE.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ H3_POLYFILL_MODE(geog, resolution, mode)

**Description**

Returns an array of H3 cell indexes contained in the given geography at a given level of detail. Containment is determined by the mode: center, intersects, contains.
Returns an array of H3 cell indexes contained in the given geography at a requested resolution. Containment is determined by the mode: center, intersects, contains.

* `geog`: `GEOGRAPHY` representing the shape to cover.
* `resolution`: `INT64` level of detail. The value must be between 0 and 15 ([H3 resolution table](https://h3geo.org/docs/core-library/restable)).
Expand Down
2 changes: 1 addition & 1 deletion clouds/bigquery/modules/doc/h3/H3_POLYFILL_TABLE.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ H3_POLYFILL_TABLE(input_query, resolution, mode, output_table)

**Description**

Returns a table with the H3 cell indexes contained in the given geography at a given level of detail. Containment is determined by the mode: center, intersects, contains. All the attributes except the geography will be included in the output table, clustered by the h3 column.
Returns a table with the H3 cell indexes contained in the given geography at a requested resolution. Containment is determined by the mode: center, intersects, contains. All the attributes except the geography will be included in the output table, clustered by the h3 column.

* `input_query`: `STRING` input data to polyfill. It must contain a column `geom` with the shape to cover. Additionally, other columns can be included.
* `resolution`: `INT64` level of detail. The value must be between 0 and 15 ([H3 resolution table](https://h3geo.org/docs/core-library/restable)).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ QUADBIN_FROMGEOGPOINT(point, resolution)

**Description**

Returns the Quadbin of a given point at a given level of detail. This function is an alias for `QUADBIN_FROMGEOPOINT`.
Returns the Quadbin of a given point at a requested resolution. This function is an alias for `QUADBIN_FROMGEOPOINT`.

* `point`: `GEOGRAPHY` point to get the Quadbin from.
* `resolution`: `INT64` level of detail or zoom.
Expand Down
2 changes: 1 addition & 1 deletion clouds/bigquery/modules/doc/quadbin/QUADBIN_FROMLONGLAT.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ QUADBIN_FROMLONGLAT(longitude, latitude, resolution)

**Description**

Returns the Quadbin representation of a point for a given level of detail and geographic coordinates.
Returns the Quadbin representation of a point for a requested resolution and geographic coordinates.

* `longitude`: `FLOAT64` longitude (WGS84) of the point.
* `latitude`: `FLOAT64` latitude (WGS84) of the point.
Expand Down
2 changes: 1 addition & 1 deletion clouds/bigquery/modules/doc/quadbin/QUADBIN_POLYFILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ QUADBIN_POLYFILL(geog, resolution)

**Description**

Returns an array of quadbin cell indexes contained in the given geography (Polygon, MultiPolygon) at a given level of detail. Containment is determined by the cells' center. This function is equivalent to [`QUADBIN_POLYFILL_MODE`](quadbin#quadbin_polyfill_mode) with mode `center`.
Returns an array of quadbin cell indexes contained in the given geography (Polygon, MultiPolygon) at a requested resolution. Containment is determined by the cells' center. This function is equivalent to [`QUADBIN_POLYFILL_MODE`](quadbin#quadbin_polyfill_mode) with mode `center`.

* `geog`: `GEOGRAPHY` representing the shape to cover.
* `resolution`: `INT64` level of detail. The value must be between 0 and 26.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ QUADBIN_POLYFILL_MODE(geog, resolution, mode)

**Description**

Returns an array of quadbin cell indexes contained in the given geography at a given level of detail. Containment is determined by the mode: center, intersects, contains.
Returns an array of quadbin cell indexes contained in the given geography at a requested resolution. Containment is determined by the mode: center, intersects, contains.

* `geog`: `GEOGRAPHY` representing the shape to cover.
* `resolution`: `INT64` level of detail. The value must be between 0 and 26.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ QUADBIN_POLYFILL_TABLE(input_query, resolution, mode, output_table)

**Description**

Returns a table with the quadbin cell indexes contained in the given geography at a given level of detail. Containment is determined by the mode: center, intersects, contains. All the attributes except the geography will be included in the output table, clustered by the quadbin column.
Returns a table with the quadbin cell indexes contained in the given geography at a requested resolution. Containment is determined by the mode: center, intersects, contains. All the attributes except the geography will be included in the output table, clustered by the quadbin column.

* `input_query`: `STRING` input data to polyfill. It must contain a column `geom` with the shape to cover. Additionally, other columns can be included.
* `resolution`: `INT64` level of detail. The value must be between 0 and 26.
Expand Down
2 changes: 1 addition & 1 deletion clouds/bigquery/modules/doc/s2/S2_FROMGEOGPOINT.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ S2_FROMGEOGPOINT(point, resolution)

**Description**

Returns the S2 cell ID of a given point at a given level of detail.
Returns the S2 cell ID of a given point at a requested resolution.

* `point`: `GEOGRAPHY` point to get the ID from.
* `resolution`: `INT64` level of detail or zoom.
Expand Down
2 changes: 1 addition & 1 deletion clouds/postgres/modules/doc/h3/H3_FROMGEOGPOINT.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ H3_FROMGEOGPOINT(point, resolution)

**Description**

Returns the H3 cell index that the point belongs to in the required `resolution`. It will return `null` on error (invalid geography type or resolution out of bounds). This function is an alias for `H3_FROMGEOPOINT`.
Returns the H3 cell index that the point belongs to in the requested `resolution`. It will return `null` on error (invalid geography type or resolution out of bounds). This function is an alias for `H3_FROMGEOPOINT`.

* `point`: `GEOMETRY` point to get the H3 cell from.
* `resolution`: `INT` number between 0 and 15 with the [H3 resolution](https://h3geo.org/docs/core-library/restable).
Expand Down
2 changes: 1 addition & 1 deletion clouds/postgres/modules/doc/h3/H3_POLYFILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ H3_POLYFILL(geom, resolution [, mode])

**Description**

Returns an array of H3 cell indexes contained in the given geometry at a given level of detail. Containment is determined by the mode: center, intersects, contains.
Returns an array of H3 cell indexes contained in the given geometry at a requested resolution. Containment is determined by the mode: center, intersects, contains.

* `geom`: `GEOMETRY` representing the shape to cover.
* `resolution`: `INT` level of detail. The value must be between 0 and 15 ([H3 resolution table](https://h3geo.org/docs/core-library/restable)).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ QUADBIN_FROMGEOGPOINT(point, resolution)

**Description**

Returns the Quadbin of a given point at a given level of detail. This function is an alias for `QUADBIN_FROMGEOPOINT`.
Returns the Quadbin of a given point at a requested resolution. This function is an alias for `QUADBIN_FROMGEOPOINT`.

* `point`: `GEOMETRY` point to get the Quadbin from.
* `resolution`: `BIGINT` level of detail or zoom.
Expand Down
2 changes: 1 addition & 1 deletion clouds/postgres/modules/doc/quadbin/QUADBIN_FROMLONGLAT.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ QUADBIN_FROMLONGLAT(longitude, latitude, resolution)

**Description**

Returns the Quadbin representation of a point for a given level of detail and geographic coordinates.
Returns the Quadbin representation of a point for a requested resolution and geographic coordinates.

* `longitude`: `DOUBLE PRECISION` longitude (WGS84) of the point.
* `latitude`: `DOUBLE PRECISION` latitude (WGS84) of the point.
Expand Down
2 changes: 1 addition & 1 deletion clouds/postgres/modules/doc/quadbin/QUADBIN_POLYFILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ QUADBIN_POLYFILL(geom, resolution [, mode])

**Description**

Returns an array of quadbin cell indexes contained in the given geometry at a given level of detail. Containment is determined by the mode: center, intersects, contains.
Returns an array of quadbin cell indexes contained in the given geometry at a requested resolution. Containment is determined by the mode: center, intersects, contains.

* `geom`: `GEOMETRY` representing the shape to cover.
* `resolution`: `INT` level of detail. The value must be between 0 and 26.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ QUADBIN_FROMGEOGPOINT(point, resolution)

**Description**

Returns the Quadbin of a given point at a given level of detail. This function is an alias for `QUADBIN_FROMGEOPOINT`.
Returns the Quadbin of a given point at a requested resolution. This function is an alias for `QUADBIN_FROMGEOPOINT`.

* `point`: `GEOMETRY` point to get the Quadbin from.
* `resolution`: `INT` level of detail or zoom.
Expand Down
2 changes: 1 addition & 1 deletion clouds/redshift/modules/doc/quadbin/QUADBIN_FROMLONGLAT.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ QUADBIN_FROMLONGLAT(longitude, latitude, resolution)

**Description**

Returns the Quadbin representation of a point for a given level of detail and geographic coordinates.
Returns the Quadbin representation of a point for a requested resolution and geographic coordinates.

* `longitude`: `FLOAT8` longitude (WGS84) of the point.
* `latitude`: `FLOAT8` latitude (WGS84) of the point.
Expand Down
2 changes: 1 addition & 1 deletion clouds/redshift/modules/doc/quadbin/QUADBIN_POLYFILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ QUADBIN_POLYFILL(geography, resolution)

**Description**

Returns an array of Quadbins that intersect with the given geography at a given level of detail.
Returns an array of Quadbins that intersect with the given geography at a requested resolution.

* `geography`: `GEOMETRY` geography to extract the Quadbins from.
* `resolution`: `INT` level of detail or zoom.
Expand Down
2 changes: 1 addition & 1 deletion clouds/redshift/modules/doc/s2/S2_FROMGEOGPOINT.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ S2_FROMGEOGPOINT(point, resolution)

**Description**

Returns the S2 cell ID of a given point at a given level of detail.
Returns the S2 cell ID of a given point at a requested resolution.

* `point`: `GEOGRAPHY` vertical coordinate of the map.
* `resolution`: `INT4` level of detail or zoom.
Expand Down
2 changes: 1 addition & 1 deletion clouds/redshift/modules/doc/s2/S2_FROMLONGLAT.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ S2_FROMLONGLAT(longitude, latitude, resolution)

**Description**

Returns the S2 cell ID representation for a given level of detail and geographic coordinates.
Returns the S2 cell ID representation for a requested resolution and geographic coordinates.

* `longitude`: `FLOAT8` horizontal coordinate of the map.
* `latitude`: `FLOAT8` vertical coordinate of the map.
Expand Down
2 changes: 1 addition & 1 deletion clouds/snowflake/modules/doc/h3/H3_FROMGEOGPOINT.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ H3_FROMGEOGPOINT(point, resolution)

**Description**

Returns the H3 cell index that the point belongs to in the required `resolution`. It will return `null` on error (invalid geography type or resolution out of bounds). This function is an alias for `H3_FROMGEOPOINT`.
Returns the H3 cell index that the point belongs to in the requested `resolution`. It will return `null` on error (invalid geography type or resolution out of bounds). This function is an alias for `H3_FROMGEOPOINT`.

* `point`: `GEOGRAPHY` point to get the H3 cell from.
* `resolution`: `INT` number between 0 and 15 with the [H3 resolution](https://h3geo.org/docs/core-library/restable).
Expand Down
2 changes: 1 addition & 1 deletion clouds/snowflake/modules/doc/h3/H3_POLYFILL_TABLE.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ H3_POLYFILL_TABLE(input_query, resolution, mode, output_table)

**Description**

Returns a table with the H3 cell indexes contained in the given geography at a given level of detail. Containment is determined by the mode: center, intersects, contains. All the attributes except the geography will be included in the output table, clustered by the h3 column.
Returns a table with the H3 cell indexes contained in the given geography at a requested resolution. Containment is determined by the mode: center, intersects, contains. All the attributes except the geography will be included in the output table, clustered by the h3 column.

* `input_query`: `STRING` input data to polyfill. It must contain a column `geom` with the shape to cover. Additionally, other columns can be included.
* `resolution`: `INT` level of detail. The value must be between 0 and 15 ([H3 resolution table](https://h3geo.org/docs/core-library/restable)).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ QUADBIN_FROMGEOGPOINT(point, resolution)

**Description**

Returns the Quadbin of a given point at a given level of detail. This function is an alias for `QUADBIN_FROMGEOPOINT`.
Returns the Quadbin of a given point at a requested resolution. This function is an alias for `QUADBIN_FROMGEOPOINT`.

* `point`: `GEOGRAPHY` point to get the Quadbin from.
* `resolution`: `INT` level of detail or zoom.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ QUADBIN_FROMLONGLAT(longitude, latitude, resolution)

**Description**

Returns the Quadbin representation of a point for a given level of detail and geographic coordinates.
Returns the Quadbin representation of a point for a requested resolution and geographic coordinates.

* `longitude`: `FLOAT64` longitude (WGS84) of the point.
* `latitude`: `FLOAT64` latitude (WGS84) of the point.
Expand Down
2 changes: 1 addition & 1 deletion clouds/snowflake/modules/doc/quadbin/QUADBIN_POLYFILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ QUADBIN_POLYFILL(geography, resolution)

**Description**

Returns an array of Quadbins that intersect with the given geography at a given level of detail.
Returns an array of Quadbins that intersect with the given geography at a requested resolution.

* `geography`: `GEOGRAPHY` geography to extract the Quadbins from.
* `resolution`: `INT` level of detail or zoom.
Expand Down
2 changes: 1 addition & 1 deletion clouds/snowflake/modules/doc/s2/S2_FROMGEOGPOINT.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ S2_FROMGEOGPOINT(point, resolution)

**Description**

Returns the S2 cell ID of a given point at a given level of detail.
Returns the S2 cell ID of a given point at a requested resolution.

* `point`: `GEOGRAPHY` point to get the ID from.
* `resolution`: `INT` level of detail or zoom.
Expand Down

0 comments on commit 48296e4

Please sign in to comment.