Terminology for Vertex is not clear and missing.
Nobody has claimed this yet.
- Dominant language
- C
- Stars
- 6.5k
- Forks
- 627
- Avg merge
- 3d 21h
- Merged PRs (30d)
- 6
Description
Having used 3D packages such as 3D Studio 4.0 I am used to thinking of a vertex as a coordinate x,y,z.
However UBER H3 library seems to use the term for an H3 Vertex as far as I can tell.
So basically a H3 Index repurposed for a H3 Vertex Index.
This API documentation mentions verteces/vertexes however it's not immediately clear if a vertex in the sense of 3D coordinate is ment or vertex in the sense of an H3 Index... H3 Vertex Index.
https://h3geo.org/docs/api/vertex
Also the H3 Terminology makes no mention of the word/term Vertex or the difference between Vertex in the 3D coordinate sense of the H3 Vertex Index sense.
https://h3geo.org/docs/library/terminology
It would be a good idea to update the documentation to more clearly explain the difference.
(
Perhaps the same could be done to indicate a cleared difference between an edge between 3D verteces and an edge index between H3 Indexes. Though I am not yet familiar unknown with H3 Edges and H3 Edge Indexes and such... I am still trying to figure this part out :)
Also I have not yet used the H3 Vertex Index functionality... but from the looks of it... I think what I am writing about is correct.
)
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the API vertex documentation at h3geo.org/docs/api/vertex and the terminology page at h3geo.org/docs/library/terminology. Clarify that an H3 vertex is an H3 Vertex Index rather than a 3D coordinate, and define the related vertex and edge terminology where appropriate. Done means the distinction is clear on both documentation pages.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100