fix/improve some comments, group add and remove functions #1054
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
Indra-db
changed the title
|
Thanks for the PR! |
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.
I changed the comment of set_lookup_path dramatically to be aligned with the comment on the C function lookup_path, as it was a lot more descriptive. However, I used the @ parameters more heavily to split it up into sections.after discussion with Sander, he instead suggested to use @see so there's no comment duplication across CPP/C API so @see has been added to set_lookup_path cpp function
I relocated the add enum function to be grouped with the other add functions. Same with Remove.
The rest is quite minor.