Skip to content

Commit 7ba6817

Browse files
committed
update JavaDoc with better grammar
Signed-off-by: Brian Flores <[email protected]>
1 parent 5e1592d commit 7ba6817

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

ml-algorithms/src/main/java/org/opensearch/ml/engine/indices/MLIndicesHandler.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,8 +67,8 @@ public class MLIndicesHandler {
6767
* @param isMultiTenancyEnabled whether multi-tenancy is enabled
6868
* @param indexName - the index to search
6969
* @return boolean indicating the existence of an index. Returns true if multitenancy is enabled.
70-
* @implNote It is recommended that if your environment enables multi tenancy, your plugin indices are
71-
* pre-populated otherwise this method will result in unwanted early returns without checking the clusterService
70+
* @implNote This method assumes if your environment enables multi tenancy, then your plugin indices are
71+
* pre-populated. If this is incorrect, it will result in unwanted early returns without checking the clusterService.
7272
*/
7373
public static boolean doesMultiTenantIndexExist(ClusterService clusterService, boolean isMultiTenancyEnabled, String indexName) {
7474
return isMultiTenancyEnabled || clusterService.state().metadata().hasIndex(indexName);

0 commit comments

Comments
 (0)