docs: clarify meaning of 'index' field in annotation models (fixes #2512) #2751
+19
−3
Conversation
This file contains hidden or 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
…enai#2512) Signed-off-by: Navadeep0007 <2400030007@kluniversity.in>
Author
|
Hi maintainers , I’ve updated the docstrings for the This aligns with the discussion in #2512. Thank you for your time and for maintaining this awesome project! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
This PR updates the docstrings for the
indexfield inAnnotationFileCitationand
AnnotationFilePathclasses to clarify that it refers to the characterposition in the message text where the citation appears, rather than the order
in the file list.
Changes
indexfields.Why
The original description was ambiguous and caused confusion (see issue #2512).
Closes #2512