Rename experimentalLocalIjToH3 to localIjToCell #586
Conversation
|
This does not include the mode that was discussed? Part of dropping the experimental part of the name was that with a mode we could add improved versions without breaking existing users. |
Correct - I can certainly add that in this PR if you think it makes sense with the renaming. |
Yeah, I think they go together. |
Updated |
src/h3lib/lib/localij.c
Outdated
| @@ -519,10 +519,15 @@ H3Error localIjkToCell(H3Index origin, const CoordIJK *ijk, H3Index *out) { | |||
| * | |||
| * @param origin An anchoring index for the ij coordinate system. | |||
| * @param index Index to find the coordinates of | |||
| * @param flags Mode flags, must be 0 | |||
There was a problem hiding this comment.
Do we want this to be a set of bitflags or an integer mode? I thought we went for the latter because we couldn't think of any combinatorial flags that would make any sense?
There was a problem hiding this comment.
I'm treating it as an opaque mode identifier without structure until we decide further.
There was a problem hiding this comment.
So, I meant the docs all say "flags"? And I thought we had decided to just make it a mode enum/integer?
There was a problem hiding this comment.
I see what you mean. In my mind these were interchangeable (I could just say there's a single flags bit field of length 32 bits). I standardized on mode.
src/h3lib/lib/localij.c
Outdated
| H3Error H3_EXPORT(localIjToCell)(H3Index origin, const CoordIJ *ij, | ||
| uint32_t mode, H3Index *out) { | ||
| if (mode != 0) { | ||
| return E_FAILED; |
There was a problem hiding this comment.
Suggestion: make a special E_INVALID_MODE? I imagine we'll need this for other cases too, and for polygonToCells
Renames
experimental...functions to no longer be experimental, as they have been in the library for some time now. Also renames the functions to be in line with the naming RFC.