-
Notifications
You must be signed in to change notification settings - Fork 472
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
Update docs to match h3-py v4.x #938
Conversation
One issue I see in the docs, however, is that the text below is shown for all the languages, but may not apply to all equally:
The Python function does not take a GeoJSON-like data structure, for example. Would it make sense to have some of the text be language-specific? |
Maybe it should be written more generally, and the parts specific to the C api placed under the appropriate tab. Preallocated memory does not apply to any of the bindings. |
I took a stab as an example. Let me know what you think! |
I don't think we explain the difference between "centroid" and "center" in the docs, but we should. The old description here makes a distinction: e3a48ad |
This is ready for review. I made a bunch of changes, so I'll re-request. |
Update the cells <> polygon functions in the h3geo.org docs to match h3-py v4.x.
Update: Also rework the h3geo.org docs so that language-agnostic function descriptions are given first, and language-specific details are given below the language tabs.
This also fixes some bugs in the docs that I found along the way.