Reorganize TermVectorsFormat format description (javadocs). #130
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
|
I think few people care about the format documentation, but at least it will not hurt anything (...and might be helpful for advanced users). |
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.
(Maybe) trivial documentation change. Current format description of TermVectorsFormat is a little bit hard to understand because various information (datatypes and explanation) is mixed up in the same line.
It could be improved if it is reorganized in a similar way to PostingsFormat; the datatypes and additional information are strictly separated there.
Screenshot of the reorganized javadoc with this pr:
Some type information was added when possible. No information was removed.