Add error returns to vertex functions #508
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dfellis
approved these changes
Aug 26, 2021
nrabinowitz
approved these changes
Aug 26, 2021
src/h3lib/lib/vertex.c
Outdated
| int cellIsPentagon = H3_EXPORT(isPentagon)(cell); | ||
| int cellNumVerts = cellIsPentagon ? NUM_PENT_VERTS : NUM_HEX_VERTS; | ||
| int res = H3_GET_RESOLUTION(cell); | ||
|
|
||
| // Check for invalid vertexes | ||
| if (vertexNum < 0 || vertexNum > cellNumVerts - 1) return H3_NULL; | ||
| if (vertexNum < 0 || vertexNum > cellNumVerts - 1) return E_FAILED; |
There was a problem hiding this comment.
Do we have an E_INVALID_INPUT error we could use here? Do we need one? It would be really useful as a developer to understand whether the input was bad or the processing failed for a different reason.
There was a problem hiding this comment.
Perhaps E_DOMAIN, "Argument was outside of acceptable range (when a more specific error code is not available)"? This seems to most closely match what you mean by E_INVALID_INPUT. We also have E_VERTEX_INVALID if the vertex argument is invalid.
| for (int i = 0; i < NUM_HEX_VERTS; i++) { | ||
| vertexes[i] = H3_EXPORT(cellToVertex)(cell, i); | ||
| if (i == 5 && isPent) { | ||
| vertexes[i] = H3_NULL; |
There was a problem hiding this comment.
👍 Better to be explicit here
ajfriend
approved these changes
Aug 26, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
These functions are not documented on the website yet, so no documentation update here.