hidingmyname opened a new pull request, #16949:
URL: https://github.com/apache/lucene/pull/16949
### Description
Small javadoc-only fixes for names and code snippets that no longer match
the code. No behavior changes.
- `vectorhighlight/package-info.java`: the `FieldFragList.add()` example
builds `SubInfo` with three arguments; the constructor takes four. Added
`phraseInfo.getBoost()`. (#16822)
- `charfilter/package-info.java`: refers to `addOffCorrectMapping()`; the
method is `BaseCharFilter.addOffCorrectMap()`. (#16823)
- `SetKeywordMarkerFilter`: constructor javadoc said
"KeywordSetMarkerFilter"; now links `SetKeywordMarkerFilter`. (#16920)
- `BM25Similarity` / `TFIDFSimilarity`: both `idfExplain` overloads said
they return "an Explain object"; now `{@link Explanation}`. (#16921)
- `UpgradeIndexMergePolicy.shouldUpgradeSegment`: the snippet used
`si.getVersion()`, which doesn't exist on `SegmentCommitInfo`; changed to
`si.info.getVersion()`, matching the method body. (#16922)
- JFlex skeletons (`skeleton.default.txt`,
`skeleton.disable.buffer.expansion.txt`): `yyreset` said the lexical state is
set to `ZZ_INITIAL`; the constant is `YYINITIAL`. The generated scanners are
regenerated in this PR. (#16927)
- Test-framework compressing codecs: six class javadocs said
"CompressionCodec"; they now link `CompressingCodec`, the actual base class.
(#16928)
- `StemmerUtil.startsWith`: summary said "starts with the suffix"; now
"prefix", matching the parameter and `@return`. (#16933)
- `HighFreqTerms.DocFreqComparator`: "Compares terms by docTermFreq" →
`{@link TermStats#docFreq}`. (#16934)
- Surround `DistanceSubQuery`: referred to `addSpanNearQueries()`; now links
`addSpanQueries(SpanNearClauseFactory)`. (#16935)
Fixes #16822
Fixes #16823
Fixes #16920
Fixes #16921
Fixes #16922
Fixes #16927
Fixes #16928
Fixes #16933
Fixes #16934
Fixes #16935
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
