This is an automated email from the ASF dual-hosted git repository.
jxue pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/helix.git
The following commit(s) were added to refs/heads/master by this push:
new 3d1729b Make the Java Doc for API more clear
3d1729b is described below
commit 3d1729b17057ece731889949919cf71b613ed2b7
Author: Junkai Xue <[email protected]>
AuthorDate: Mon Sep 23 16:57:15 2019 -0700
Make the Java Doc for API more clear
Some users got confused with inputs based on the Java doc. Make it more
clear for user usage.
---
helix-core/src/main/java/org/apache/helix/util/HelixUtil.java | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/helix-core/src/main/java/org/apache/helix/util/HelixUtil.java
b/helix-core/src/main/java/org/apache/helix/util/HelixUtil.java
index ef2e578..5e7f7b4 100644
--- a/helix-core/src/main/java/org/apache/helix/util/HelixUtil.java
+++ b/helix-core/src/main/java/org/apache/helix/util/HelixUtil.java
@@ -143,8 +143,8 @@ public final class HelixUtil {
/**
* This method provides the ideal state mapping with corresponding rebalance
strategy
* @param clusterConfig The cluster config
- * @param instanceConfigs List of instance configs
- * @param liveInstances List of live instance names
+ * @param instanceConfigs List of all existing instance configs
including disabled/down instances
+ * @param liveInstances List of live and enabled instance names
* @param idealState The ideal state of current resource. If
input is null, will be
* treated as newly created resource.
* @param partitions The list of partition names
