PayloadScoreQuery javadoc update w.r.t. SpanQuery use (#13731)

apache · Sep 12, 2024 · ef577ea · ef577ea
1 parent 74e3c44
commit ef577ea
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/lucene/queries/src/java/org/apache/lucene/queries/payloads/PayloadScoreQuery.java b/lucene/queries/src/java/org/apache/lucene/queries/payloads/PayloadScoreQuery.java
@@ -39,7 +39,11 @@
 import org.apache.lucene.search.ScorerSupplier;
 import org.apache.lucene.util.BytesRef;
 
-/** A Query class that uses a {@link PayloadFunction} to modify the score of a wrapped SpanQuery */
+/**
+ * A Query class that uses a {@link PayloadFunction} to modify the score of a wrapped {@link
+ * SpanQuery}. A wrapped span query is used due to the way that payload values are indexed, see
+ * {@link PostingsEnum#PAYLOADS}.
+ */
 public class PayloadScoreQuery extends SpanQuery {
 
   private final SpanQuery wrappedQuery;