Docstring updates #921
Merged
Docstring updates #921
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
|
This should be ready for review now. |
dfellis
reviewed
Oct 20, 2024
| @@ -127,7 +127,7 @@ H3Error H3_EXPORT(areNeighborCells)(H3Index origin, H3Index destination, | |||
| * destination | |||
| * @param origin The origin H3 hexagon index | |||
| * @param destination The destination H3 hexagon index | |||
| * @return The directed edge H3Index, or H3_NULL on failure. | |||
| * @param out Output: The directed edge H3Index. | |||
There was a problem hiding this comment.
Should we include the @return still for the H3Error path?
There was a problem hiding this comment.
Eg, just copy this from further below:
Suggested change
| * @param out Output: The directed edge H3Index. | |
| * @param out Output: The directed edge H3Index. | |
| * @returns E_SUCCESS on success, or another value on error |
There was a problem hiding this comment.
I was most focused on ensuring the docstring wasn't incorrect, rather than completing it. That seems like a good addition.
ajfriend
approved these changes
Nov 18, 2024
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.
This updates the doc strings in a few places to be consistent with the actual parameters. I also changed Doxygen settings to improve that a little, e.g. to include the public API header.
Based on #919, #920.