update docs

karafka · Jan 29, 2024 · 18cb606 · 18cb606
1 parent a01b0ba
commit 18cb606
Showing 1 changed file with 3 additions and 2 deletions.
diff --git 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