Skip to content

Commit

Permalink
add a warning about lat/lng order
Browse files Browse the repository at this point in the history
  • Loading branch information
ajfriend committed Apr 16, 2024
1 parent 1686048 commit 8d7d9d8
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion docs/api_quick.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
# API Quick Reference


```{attention}
Function names changed significantly with `h3-py` `v4.0` to align with the C library: https://h3geo.org/docs/library/migration-3.x/functions
```
Expand Down Expand Up @@ -120,6 +119,11 @@ The objects and functions also compatible with the popular [``__geo_interface__`

See the [polygon tutorial](./polygon_tutorial.ipynb) for a walkthrough.

```{warning}
As with other `h3-py` functions, the polygon interface expects coordinate pairs in **lat/lng** order.
Note that this is reversed from ``__geo_interface__`` objects, which are given in **lng/lat** order.
```

### Polygon objects

```{eval-rst}
Expand Down

0 comments on commit 8d7d9d8

Please sign in to comment.