From 18cb60623eeb1ec6c1a6022ef4535045ee3f7254 Mon Sep 17 00:00:00 2001
From: Maciej Mensfeld <maciej@mensfeld.pl>
Date: Mon, 29 Jan 2024 13:25:11 +0100
Subject: [PATCH] update docs

---
 lib/waterdrop/producer.rb | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/lib/waterdrop/producer.rb b/lib/waterdrop/producer.rb
index cc983d42..41233963 100644
--- a/lib/waterdrop/producer.rb
+++ b/lib/waterdrop/producer.rb
@@ -125,9 +125,10 @@ def client
     # Fetches and caches the partition count of a topic
     #
     # @param topic [String] topic for which we want to get the number of partitions
-    # @return [Integer] number of partitions of the requested topic
+    # @return [Integer] number of partitions of the requested topic or -1 if number could not be
+    #   retrieved.
     #
-    # @note It uses the underlying `rdkafka-ruby` partition count cache.
+    # @note It uses the underlying `rdkafka-ruby` partition count fetch and cache.
     def partition_count(topic)
       client.partition_count(topic.to_s)
     end