LUCENE-9353: revise format documentation of Lucene90BlockTreeTermsWriter #90
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
|
@jpountz Could you take a look at this. |
jpountz
approved these changes
Apr 19, 2021
.../core/src/java/org/apache/lucene/codecs/lucene90/blocktree/Lucene90BlockTreeTermsWriter.java
Outdated
Show resolved
Hide resolved
| * <li>TermsMeta (.tmd) --> Header, NumFields, <FieldStats><sup>NumFields</sup>, | ||
| * TermIndexLength, TermDictLength, Footer | ||
| * <li>FieldStats --> FieldNumber, NumTerms, RootCodeLength, Byte<sup>RootCodeLength</sup>, | ||
| * SumTotalTermFreq?, SumDocFreq, DocCount, MinTerm, MaxTerm, IndexStartFP, FSTHeader, |
There was a problem hiding this comment.
I think it is SumDocFreq which is not always specified rather than SumTotalTermFreq?
Suggested change
| * SumTotalTermFreq?, SumDocFreq, DocCount, MinTerm, MaxTerm, IndexStartFP, FSTHeader, | |
| * SumTotalTermFreq, SumDocFreq?, DocCount, MinTerm, MaxTerm, IndexStartFP, FSTHeader, |
There was a problem hiding this comment.
I'm actually not the author of the line (I just moved it from the above section to here), but the specification seems to be correct to me.
Co-authored-by: Adrien Grand <jpountz@gmail.com>
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.
It seems that the javadocs needs to be revised. I tried to reflect the changes in apache/lucene-solr#1473 to the format description.
latest javadocs
generated javadocs with the patch