(lucene) branch main updated: Complete the javadoc for DirectoryReader#indexExists (#14136)

[dw...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

dweiss pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/lucene.git


The following commit(s) were added to refs/heads/main by this push:
     new b87757c2d2f Complete the javadoc for DirectoryReader#indexExists (#14136)
b87757c2d2f is described below

commit b87757c2d2f7aa9847268b058c59c2d2ef11a9cf
Author: Craig Perkins <cw...@amazon.com>
AuthorDate: Wed Jan 15 07:21:32 2025 -0500

    Complete the javadoc for DirectoryReader#indexExists (#14136)
    
    Thank you!
---
 lucene/core/src/java/org/apache/lucene/index/DirectoryReader.java | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/lucene/core/src/java/org/apache/lucene/index/DirectoryReader.java b/lucene/core/src/java/org/apache/lucene/index/DirectoryReader.java
index d50ae3a85cb..7571a7f0d07 100644
--- a/lucene/core/src/java/org/apache/lucene/index/DirectoryReader.java
+++ b/lucene/core/src/java/org/apache/lucene/index/DirectoryReader.java
@@ -305,7 +305,8 @@ public abstract class DirectoryReader extends BaseCompositeReader<LeafReader> {
 
   /**
    * Returns <code>true</code> if an index likely exists at the specified directory. Note that if a
-   * corrupt index exists, or if an index in the process of committing
+   * corrupt index exists, or if an index in the process of committing the return value is not
+   * reliable.
    *
    * @param directory the directory to check for an index
    * @return <code>true</code> if an index exists; <code>false</code> otherwise