Clarifies function comment blocks re: defpath #150
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
Updates documentation for `ncx_find_any_object` to clarify that only the first object of a given name is returned.
Clarifies `find_schema_node_int` to describe behavior when no prefix is given and multiple top-level objects share a name.
Clarifies agt_cb_register_callback documentation for the case where no prefix is specified and there are multiple synonymous top-level objects.
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.
Relates to #140
This PR clarifies relevant functions comment blocks to more clearly reflect the behavior discussed in the issue above. This does not resolve the issue but changes 3 comment blocks to better document the namespace search behavior and allow SIL developers to more easily identify the cause of
ERR_NCX_DEFSEG_NOT_FOUND.