From 3f99b57da4ad4936d130c1b79775b75c644bcefe Mon Sep 17 00:00:00 2001
From: watermelo <80680489@qq.com>
Date: Thu, 4 Jun 2020 00:33:46 +0800
Subject: [PATCH] Mod: update cluster comments after review

---
 cluster/cluster.go                                | 2 +-
 cluster/cluster_impl/available_cluster.go         | 2 +-
 cluster/cluster_impl/available_cluster_invoker.go | 2 +-
 cluster/cluster_impl/broadcast_cluster.go         | 4 ++--
 cluster/cluster_impl/failback_cluster.go          | 2 +-
 cluster/cluster_impl/failfast_cluster.go          | 2 +-
 cluster/cluster_impl/failover_cluster.go          | 4 ++--
 cluster/cluster_impl/failsafe_cluster.go          | 5 +++--
 cluster/cluster_impl/forking_cluster.go           | 4 ++--
 cluster/cluster_impl/mock_cluster.go              | 4 ++--
 cluster/cluster_impl/registry_aware_cluster.go    | 2 +-
 cluster/directory.go                              | 2 +-
 cluster/loadbalance.go                            | 2 +-
 cluster/loadbalance/least_active.go               | 5 +++--
 cluster/loadbalance/random.go                     | 4 ++--
 cluster/loadbalance/round_robin.go                | 2 +-
 16 files changed, 25 insertions(+), 23 deletions(-)

diff --git a/cluster/cluster.go b/cluster/cluster.go
index 7713a7bb9..7a0df4c0a 100644
--- a/cluster/cluster.go
+++ b/cluster/cluster.go
@@ -22,7 +22,7 @@ import (
 )
 
 // Cluster
-//Extension - Cluster
+// Extension - Cluster
 type Cluster interface {
 	Join(Directory) protocol.Invoker
 }
diff --git a/cluster/cluster_impl/available_cluster.go b/cluster/cluster_impl/available_cluster.go
index 9c40b47ea..b70a97fad 100644
--- a/cluster/cluster_impl/available_cluster.go
+++ b/cluster/cluster_impl/available_cluster.go
@@ -31,7 +31,7 @@ func init() {
 	extension.SetCluster(available, NewAvailableCluster)
 }
 
-// NewAvailableCluster returns cluster instance
+// NewAvailableCluster returns a cluster instance
 //
 // Obtain available service providers
 func NewAvailableCluster() cluster.Cluster {
diff --git a/cluster/cluster_impl/available_cluster_invoker.go b/cluster/cluster_impl/available_cluster_invoker.go
index bb1380556..39a892379 100644
--- a/cluster/cluster_impl/available_cluster_invoker.go
+++ b/cluster/cluster_impl/available_cluster_invoker.go
@@ -35,7 +35,7 @@ type availableClusterInvoker struct {
 	baseClusterInvoker
 }
 
-// NewAvailableClusterInvoker returns cluster invoker instance
+// NewAvailableClusterInvoker returns a cluster invoker instance
 func NewAvailableClusterInvoker(directory cluster.Directory) protocol.Invoker {
 	return &availableClusterInvoker{
 		baseClusterInvoker: newBaseClusterInvoker(directory),
diff --git a/cluster/cluster_impl/broadcast_cluster.go b/cluster/cluster_impl/broadcast_cluster.go
index 581151f61..ba454af6a 100644
--- a/cluster/cluster_impl/broadcast_cluster.go
+++ b/cluster/cluster_impl/broadcast_cluster.go
@@ -31,9 +31,9 @@ func init() {
 	extension.SetCluster(broadcast, NewBroadcastCluster)
 }
 
-// NewBroadcastCluster returns broadcast cluster instance
+// NewBroadcastCluster returns a broadcast cluster instance.
 //
-// Calling all providers broadcast, one by one call, any error is reported.
+// Calling all providers' broadcast one by one. All errors will be reported.
 // It is usually used to notify all providers to update local resource information such as caches or logs.
 func NewBroadcastCluster() cluster.Cluster {
 	return &broadcastCluster{}
diff --git a/cluster/cluster_impl/failback_cluster.go b/cluster/cluster_impl/failback_cluster.go
index ebad70c84..432e33122 100644
--- a/cluster/cluster_impl/failback_cluster.go
+++ b/cluster/cluster_impl/failback_cluster.go
@@ -31,7 +31,7 @@ func init() {
 	extension.SetCluster(failback, NewFailbackCluster)
 }
 
-// NewFailbackCluster returns failback cluster instance
+// NewFailbackCluster returns a failback cluster instance
 //
 // Failure automatically restored, failed to record the background request,
 // regular retransmission. Usually used for message notification operations.
diff --git a/cluster/cluster_impl/failfast_cluster.go b/cluster/cluster_impl/failfast_cluster.go
index 8d8177b7c..ac9ec6b82 100644
--- a/cluster/cluster_impl/failfast_cluster.go
+++ b/cluster/cluster_impl/failfast_cluster.go
@@ -31,7 +31,7 @@ func init() {
 	extension.SetCluster(failfast, NewFailFastCluster)
 }
 
-// NewFailFastCluster returns failfast cluster instance
+// NewFailFastCluster returns a failfast cluster instance.
 //
 // Fast failure, only made a call, failure immediately error. Usually used for non-idempotent write operations,
 // such as adding records.
diff --git a/cluster/cluster_impl/failover_cluster.go b/cluster/cluster_impl/failover_cluster.go
index 6c32a8c25..d30a743e0 100644
--- a/cluster/cluster_impl/failover_cluster.go
+++ b/cluster/cluster_impl/failover_cluster.go
@@ -31,9 +31,9 @@ func init() {
 	extension.SetCluster(name, NewFailoverCluster)
 }
 
-// NewFailoverCluster returns failover cluster instance
+// NewFailoverCluster returns a failover cluster instance
 //
-// Failure automatically switch, when there is failure,
+// Failure automatically switch, when there is a failure,
 // retry the other server (default). Usually used for read operations,
 // but retries can result in longer delays.
 func NewFailoverCluster() cluster.Cluster {
diff --git a/cluster/cluster_impl/failsafe_cluster.go b/cluster/cluster_impl/failsafe_cluster.go
index e88690f0a..f708b7fb9 100644
--- a/cluster/cluster_impl/failsafe_cluster.go
+++ b/cluster/cluster_impl/failsafe_cluster.go
@@ -31,9 +31,10 @@ func init() {
 	extension.SetCluster(failsafe, NewFailsafeCluster)
 }
 
-// NewFailsafeCluster returns failsafe cluster instance
+// NewFailsafeCluster returns a failsafe cluster instance.
 //
-// Failure of security, anomalies, directly ignored. Usually used to write audit logs and other operations.
+// Failure of security, anomalies, directly ignored. Usually it is
+// used to write audit logs and other operations.
 func NewFailsafeCluster() cluster.Cluster {
 	return &failsafeCluster{}
 }
diff --git a/cluster/cluster_impl/forking_cluster.go b/cluster/cluster_impl/forking_cluster.go
index 720f8d118..0e6cd2688 100644
--- a/cluster/cluster_impl/forking_cluster.go
+++ b/cluster/cluster_impl/forking_cluster.go
@@ -31,10 +31,10 @@ func init() {
 	extension.SetCluster(forking, NewForkingCluster)
 }
 
-// NewForkingCluster returns forking cluster instance
+// NewForkingCluster returns a forking cluster instance.
 //
 // Multiple servers are invoked in parallel, returning as soon as one succeeds.
-// Usually used for real-time demanding read operations, but need to waste more service resources.
+// Usually it is used for real-time demanding read operations while wasting more service resources.
 func NewForkingCluster() cluster.Cluster {
 	return &forkingCluster{}
 }
diff --git a/cluster/cluster_impl/mock_cluster.go b/cluster/cluster_impl/mock_cluster.go
index 6ad75cf1b..d887cfb45 100644
--- a/cluster/cluster_impl/mock_cluster.go
+++ b/cluster/cluster_impl/mock_cluster.go
@@ -24,11 +24,11 @@ import (
 
 type mockCluster struct{}
 
-// NewMockCluster returns mock cluster instance
+// NewMockCluster returns a mock cluster instance.
 //
 // Mock cluster is usually used for service degradation, such as an authentication service.
 // When the service provider is completely hung up, the client does not throw an exception,
-// but returns the authorization failure through the Mock data.
+// return an authorization failure through the Mock data instead.
 func NewMockCluster() cluster.Cluster {
 	return &mockCluster{}
 }
diff --git a/cluster/cluster_impl/registry_aware_cluster.go b/cluster/cluster_impl/registry_aware_cluster.go
index 58618951a..fcefa5286 100644
--- a/cluster/cluster_impl/registry_aware_cluster.go
+++ b/cluster/cluster_impl/registry_aware_cluster.go
@@ -29,7 +29,7 @@ func init() {
 	extension.SetCluster("registryAware", NewRegistryAwareCluster)
 }
 
-// NewRegistryAwareCluster returns registry aware cluster instance
+// NewRegistryAwareCluster returns a registry aware cluster instance
 func NewRegistryAwareCluster() cluster.Cluster {
 	return &registryAwareCluster{}
 }
diff --git a/cluster/directory.go b/cluster/directory.go
index 5a03b3a44..37f0c3282 100644
--- a/cluster/directory.go
+++ b/cluster/directory.go
@@ -23,7 +23,7 @@ import (
 )
 
 // Directory
-//Extension - Directory
+// Extension - Directory
 type Directory interface {
 	common.Node
 	List(invocation protocol.Invocation) []protocol.Invoker
diff --git a/cluster/loadbalance.go b/cluster/loadbalance.go
index fb3641a77..a5b344a49 100644
--- a/cluster/loadbalance.go
+++ b/cluster/loadbalance.go
@@ -22,7 +22,7 @@ import (
 )
 
 // LoadBalance
-//Extension - LoadBalance
+// Extension - LoadBalance
 type LoadBalance interface {
 	Select([]protocol.Invoker, protocol.Invocation) protocol.Invoker
 }
diff --git a/cluster/loadbalance/least_active.go b/cluster/loadbalance/least_active.go
index 7eff05bd1..37ad91c3e 100644
--- a/cluster/loadbalance/least_active.go
+++ b/cluster/loadbalance/least_active.go
@@ -28,6 +28,7 @@ import (
 )
 
 const (
+	// LeastActive is used to set the load balance extension
 	LeastActive = "leastactive"
 )
 
@@ -38,9 +39,9 @@ func init() {
 type leastActiveLoadBalance struct {
 }
 
-// NewLeastActiveLoadBalance returns least active load balance
+// NewLeastActiveLoadBalance returns a least active load balance.
 //
-// A random mechanism based on actives, actives means the num of requests a consumer have sent but not return yet
+// A random mechanism based on actives, actives means the number of a consumer's requests have been sent to provider but not yet got response.
 func NewLeastActiveLoadBalance() cluster.LoadBalance {
 	return &leastActiveLoadBalance{}
 }
diff --git a/cluster/loadbalance/random.go b/cluster/loadbalance/random.go
index d5a8471e8..cdde1b41f 100644
--- a/cluster/loadbalance/random.go
+++ b/cluster/loadbalance/random.go
@@ -38,9 +38,9 @@ func init() {
 type randomLoadBalance struct {
 }
 
-// NewRandomLoadBalance returns random load balance instance
+// NewRandomLoadBalance returns a random load balance instance.
 //
-// Set random probabilities by weight, the request sent to provider is random
+// Set random probabilities by weight, and the request will be sent to provider randomly.
 func NewRandomLoadBalance() cluster.LoadBalance {
 	return &randomLoadBalance{}
 }
diff --git a/cluster/loadbalance/round_robin.go b/cluster/loadbalance/round_robin.go
index 587e059b3..c44b239db 100644
--- a/cluster/loadbalance/round_robin.go
+++ b/cluster/loadbalance/round_robin.go
@@ -52,7 +52,7 @@ func init() {
 
 type roundRobinLoadBalance struct{}
 
-// NewRoundRobinLoadBalance returns round robin load balance
+// NewRoundRobinLoadBalance returns a round robin load balance
 //
 // Use the weight's common advisory to determine round robin ratio
 func NewRoundRobinLoadBalance() cluster.LoadBalance {
-- 
GitLab