From de8a6998d7e9277632f1621f10150f338202383d Mon Sep 17 00:00:00 2001 From: sunwq Date: Mon, 16 May 2022 12:34:29 +0800 Subject: [PATCH] LUCENE-10568: fix javadocs errors in IndexWriter.DocStats (#884) --- .../src/java/org/apache/lucene/index/IndexWriter.java | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/lucene/core/src/java/org/apache/lucene/index/IndexWriter.java b/lucene/core/src/java/org/apache/lucene/index/IndexWriter.java index 7efeb932888..484006fc420 100644 --- a/lucene/core/src/java/org/apache/lucene/index/IndexWriter.java +++ b/lucene/core/src/java/org/apache/lucene/index/IndexWriter.java @@ -6198,14 +6198,15 @@ public class IndexWriter /** DocStats for this index */ public static final class DocStats { /** - * The total number of docs in this index, including docs not yet flushed (still in the RAM - * buffer), not counting deletions. + * The total number of docs in this index, counting docs not yet flushed (still in the RAM + * buffer), and also counting deleted docs. NOTE: buffered deletions are not counted. If + * you really need these to be counted you should call {@link IndexWriter#commit()} first. */ public final int maxDoc; + /** - * The total number of docs in this index, including docs not yet flushed (still in the RAM - * buffer), and including deletions. NOTE: buffered deletions are not counted. If you - * really need these to be counted you should call {@link IndexWriter#commit()} first. + * The total number of docs in this index, counting docs not yet flushed (still in the RAM + * buffer), but not counting deleted docs. */ public final int numDocs;