Skip to content

Commit f07b4c1

Browse files
committed
Fix "@param tag has unknown parameter name"
This commit resolves the following warnings: ``` % yard doc [warn]: @param tag has unknown parameter name: group_id: in file `lib/kafka/cluster.rb' near line 122 [warn]: @param tag has unknown parameter name: transactional_id: in file `lib/kafka/cluster.rb' near line 132 [warn]: @param tag has unknown parameter name: string in file `lib/kafka/protocol/encoder.rb' near line 131 -- snip -- ```
1 parent a56d16b commit f07b4c1

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

Diff for: lib/kafka/cluster.rb

+2-2
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ def get_leader(topic, partition)
117117

118118
# Finds the broker acting as the coordinator of the given group.
119119
#
120-
# @param group_id: [String]
120+
# @param group_id [String]
121121
# @return [Broker] the broker that's currently coordinator.
122122
def get_group_coordinator(group_id:)
123123
@logger.debug "Getting group coordinator for `#{group_id}`"
@@ -127,7 +127,7 @@ def get_group_coordinator(group_id:)
127127

128128
# Finds the broker acting as the coordinator of the given transaction.
129129
#
130-
# @param transactional_id: [String]
130+
# @param transactional_id [String]
131131
# @return [Broker] the broker that's currently coordinator.
132132
def get_transaction_coordinator(transactional_id:)
133133
@logger.debug "Getting transaction coordinator for `#{transactional_id}`"

Diff for: lib/kafka/protocol/encoder.rb

+1-1
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ def write_varint_string(string)
126126
# Writes an integer under varints serializing to the IO object.
127127
# https://developers.google.com/protocol-buffers/docs/encoding#varints
128128
#
129-
# @param string [Integer]
129+
# @param int [Integer]
130130
# @return [nil]
131131
def write_varint(int)
132132
int = int << 1

0 commit comments

Comments
 (0)