Add some comments

CAFxX · May 15, 2016 · 6170793 · 6170793
1 parent ddb66ae
commit 6170793
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/balancer.go b/balancer.go
@@ -7,6 +7,7 @@ import (
 	"runtime"
 )
 
+// RebalanceConfig contains the configuration that drives the rebalancing.
 type RebalanceConfig struct {
 	AllowLeaderRebalancing    bool
 	MinReplicasForRebalancing int
@@ -15,6 +16,8 @@ type RebalanceConfig struct {
 	Brokers []BrokerID
 }
 
+// DefaultRebalanceConfig returns the default RebalanceConfig. These values are
+// also the one used as the default values for the CLI flags.
 func DefaultRebalanceConfig() RebalanceConfig {
 	return RebalanceConfig{
 		AllowLeaderRebalancing:    false,