dsmiley commented on a change in pull request #362:
URL: https://github.com/apache/lucene/pull/362#discussion_r734203232
##########
File path:
lucene/highlighter/src/java/org/apache/lucene/search/uhighlight/UnifiedHighlighter.java
##########
@@ -1168,9 +1174,12 @@ public CacheHelper getReaderCacheHelper() {
/**
* Internally use the {@link Weight#matches(LeafReaderContext, int)} API
for highlighting. It's
- * more accurate to the query, though might not calculate passage
relevancy as well. Use of this
- * flag requires {@link #MULTI_TERM_QUERY} and {@link #PHRASES}. {@link
- * #PASSAGE_RELEVANCY_OVER_SPEED} will be ignored. False by default.
+ * more accurate to the query, and the snippets can be a little different
for phrases because
+ * the whole phrase is marked up instead of each word. The passage
relevancy calculation can be
+ * different (maybe worse?) and it's slower when highlighting many fields.
Use of this flag
+ * requires {@link #MULTI_TERM_QUERY} and {@link #PHRASES}. {@link
+ * #PASSAGE_RELEVANCY_OVER_SPEED} will be ignored. True by default, so
long as the requirements
Review comment:
I may have misstated it. I improved the JavaDocs just now for clarity.
What's confusing is that it's theoretically possible to subclass and return
WEIGHT_MATCHES without some of the other flags, and so the JavaDocs were saying
basically that if you do that, then PASSAGE_RELEVANCY_OVER_SPEED will be
ignored. But I think it's clearer to speak of the 3 requirements in the same
way. And perhaps PASSAGE_RELEVANCY_OVER_SPEED should be an internal/expert
option that is more of a hold-over from earlier times which has questionable
value to me.
--
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]