LUCENE-4198: add format description for term impacts to javadocs #115
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
mocobeta
commented
Apr 29, 2021
| * <li>ImpactLength is the total length of CompetitiveFreqDelta and CompetitiveNormDelta | ||
| * pairs. CompetitiveFreqDelta and CompetitiveNormDelta are used to safely skip score | ||
| * calculation for uncompetitive documents; See {@link | ||
| * org.apache.lucene.codecs.CompetitiveImpactAccumulator} for more details. |
There was a problem hiding this comment.
Also added brief description about the impacts.
mocobeta
commented
Apr 29, 2021
| @@ -299,7 +306,7 @@ | |||
| * positions. Some payloads and offsets will be separated out into .pos file, for performance | |||
| * reasons. | |||
| * <ul> | |||
| * <li>PayFile(.pay): --> Header, <TermPayloads, TermOffsets?> | |||
| * <li>PayFile(.pay): --> Header, <TermPayloads?, TermOffsets?> | |||
There was a problem hiding this comment.
It is not related to LUCENE-4198 at all... but TermPayloads seems to be optional as well as TermOffsets.
|
@jpountz Could you take a look at this. |
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.
https://issues.apache.org/jira/browse/LUCENE-4198 introduced term impacts to PostingsFormat; this is a follow-up to fix the format documentation ("SkipDatum" part) to reflect the changes.
latest javadocs (for .doc file)
modified javadocs with this patch (for .doc file)
