From f07b4c122d03dca3c789c452ca36885e3e120b6f Mon Sep 17 00:00:00 2001 From: abicky Date: Thu, 15 Apr 2021 05:09:31 +0900 Subject: [PATCH] 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 -- ``` --- lib/kafka/cluster.rb | 4 ++-- lib/kafka/protocol/encoder.rb | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/lib/kafka/cluster.rb b/lib/kafka/cluster.rb index bc3717e8c..98c813bb9 100644 --- a/lib/kafka/cluster.rb +++ b/lib/kafka/cluster.rb @@ -117,7 +117,7 @@ def get_leader(topic, partition) # Finds the broker acting as the coordinator of the given group. # - # @param group_id: [String] + # @param group_id [String] # @return [Broker] the broker that's currently coordinator. def get_group_coordinator(group_id:) @logger.debug "Getting group coordinator for `#{group_id}`" @@ -127,7 +127,7 @@ def get_group_coordinator(group_id:) # Finds the broker acting as the coordinator of the given transaction. # - # @param transactional_id: [String] + # @param transactional_id [String] # @return [Broker] the broker that's currently coordinator. def get_transaction_coordinator(transactional_id:) @logger.debug "Getting transaction coordinator for `#{transactional_id}`" diff --git a/lib/kafka/protocol/encoder.rb b/lib/kafka/protocol/encoder.rb index d4bc7a391..56a584a01 100644 --- a/lib/kafka/protocol/encoder.rb +++ b/lib/kafka/protocol/encoder.rb @@ -126,7 +126,7 @@ def write_varint_string(string) # Writes an integer under varints serializing to the IO object. # https://developers.google.com/protocol-buffers/docs/encoding#varints # - # @param string [Integer] + # @param int [Integer] # @return [nil] def write_varint(int) int = int << 1