Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

'latlng_to_cell' function is deprecated, but still referred to in the API docs and readme #306

Open
atharva-choudhary opened this issue Jan 12, 2023 · 6 comments

Comments

@atharva-choudhary
Copy link

It should probably be replaced by the function 'geo_to_h3' instead.

@nrabinowitz
Copy link
Collaborator

I think there's some confusion here - latlng_to_cell is the correct H3v4 name. The name geo_to_h3 is the H3v3 name. Neither is deprecated per se, as the H3 version you are using will determine which is available, but latlng_to_cell is more current.

@timminata
Copy link

timminata commented Jan 16, 2023

It is really confusing - if I follow the instructions in the Readme it installs h3 v3.7.6 and I get AttributeError: module 'h3' has no attribute 'latlng_to_cell'. To get it to work I have to then uninstall and run pip install h3 --pre
What am I missing? All the docs including https://h3geo.org/docs/ seem to assume everyone is on version 4 which is a strange assumption given it's pre-release. Thanks!

@dfellis
Copy link
Collaborator

dfellis commented Jan 16, 2023

Only h3-py has not yet released on v4. The C library and the Java and Javascript bindings have already been fully upgraded.

I believe h3-py has held back because there was a significant restructuring of the binding code at the same time as the v4 release, so @ajfriend wanted to kick the tires a bit longer to make sure there's no regressions.

@timminata
Copy link

Thanks @dfellis - do you think it's better to stick with 3.7 or jump to the pre-release now? I think the main function I need is geo_to_h3 or if I'm on v4 then I will probably use polygon_to_cells. It would be nice to avoid having to re-work and migrate when v4 is released so I suppose it depends a bit on how far out that it. Thanks for any advice!

@mohit-at-delhivery
Copy link

Really this is getting so confusing as the documentation is only available for version 4. May we please know when will the stable version 4 for python be released?

@janikmu
Copy link

janikmu commented Jun 22, 2023

Really this is getting so confusing as the documentation is only available for version 4.

I second this, it would be super helpful if the docs at https://uber.github.io/h3-py/api_reference.html had a version toggle, or at least the latest v3 docs would be compiled and still available somewhere static, for reference, as long as v3 is still the stable version that pip install h3 installs, instead of needing to go through the v3 uncompiled doc files and code in Github.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

6 participants