Add docs for h3Distance #101
Conversation
|
|
||
| Returns the distance in grid cells between the two indexes. | ||
|
|
||
| Returns a negative number if finding the distance failed. Finding the distance can fail because the two |
There was a problem hiding this comment.
Is it worth outlining the meaning of the different error codes here?
There was a problem hiding this comment.
h3Distance itself only returns -1 on any kind of error right now, it doesn't preserve the more specific error code from h3ToIjk
|
Out of curiousity, does our doc setup mean this will be published right away, before we actually cut a release with this functionality? Can we add something to the docs that indicates what version of the library they document? |
|
@nrabinowitz Our doc setup requires manually building the docs and pushing them to the gh-pages branch, so this will not be published until both merged and the docs are rebuilt. It would be really nice to have a proper control on each of the docs page that says e.g. "Since: 3.1.0" or "Since: 3.0.0" or other annotations. |
Add docs for h3Distance
Begins docs for #83, and adds
h3Distanceto the example.