uber / h3

Hexagonal hierarchical geospatial indexing system
https://h3geo.org
Apache License 2.0
4.95k stars 470 forks source link

h3geo.org Python documentation appears incorrect for 4.1.1 #942

Closed rohanaras closed 1 week ago

rohanaras commented 1 week ago

The documentation for few of the h3 4.x geometry related functions appear to be incorrect at https://h3geo.org/docs/api/misc/. After reading through a few of the other issues here, I realized that I should be using the Python specific documentation, which appear correct. Regardless, this is something that is confusing and should be fixed imo.

Here is a list of the differences I noticed, though this could be incomplete:

ajfriend commented 1 week ago

You're totally right. Thanks for spotting!

If you wanted to take a stab at updating the h3geo.org docs, that would definitely be appreciated. And it shouldn't be too hard to update / we'd be happy to answer any questions.

Otherwise, I'll try to update the doc myself soon.