Skip to content

Commit 9bc3d14

Browse files
authored
chore(client): update comments of client methods (#3295)
This PR updates the comments of methods TransactionCoordinator/RefreshTransactionCoordinator in saram.Client. Signed-off-by: gunli <[email protected]>
1 parent 096b846 commit 9bc3d14

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

client.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -98,13 +98,13 @@ type Client interface {
9898
// in local cache. This function only works on Kafka 0.8.2 and higher.
9999
RefreshCoordinator(consumerGroup string) error
100100

101-
// Coordinator returns the coordinating broker for a transaction id. It will
101+
// TransactionCoordinator returns the coordinating broker for a transaction id. It will
102102
// return a locally cached value if it's available. You can call
103103
// RefreshCoordinator to update the cached value. This function only works on
104104
// Kafka 0.11.0.0 and higher.
105105
TransactionCoordinator(transactionID string) (*Broker, error)
106106

107-
// RefreshCoordinator retrieves the coordinator for a transaction id and stores it
107+
// RefreshTransactionCoordinator retrieves the coordinator for a transaction id and stores it
108108
// in local cache. This function only works on Kafka 0.11.0.0 and higher.
109109
RefreshTransactionCoordinator(transactionID string) error
110110

@@ -114,7 +114,7 @@ type Client interface {
114114
// LeastLoadedBroker retrieves broker that has the least responses pending
115115
LeastLoadedBroker() *Broker
116116

117-
// check if partition is readable
117+
// PartitionNotReadable checks if partition is not readable
118118
PartitionNotReadable(topic string, partition int32) bool
119119

120120
// Close shuts down all broker connections managed by this client. It is required

0 commit comments

Comments
 (0)