Document RdkafkaError

Author: thijsc

.yardopts

@@ -1 +1,2 @@
 --no-private
+--markup=markdown

lib/rdkafka/error.rb

@@ -1,12 +1,18 @@
 module Rdkafka
+  # Error returned by the underlying rdkafka library.
   class RdkafkaError < RuntimeError
+    # The underlying raw error response
+    # @return [Integer]
     attr_reader :rdkafka_response
 
+    # @private
     def initialize(response)
       raise TypeError.new("Response has to be an integer") unless response.is_a? Integer
       @rdkafka_response = response
     end
 
+    # This error's code, for example `:partition_eof`, `:msg_size_too_large`.
+    # @return [Symbol]
     def code
       code = Rdkafka::FFI.rd_kafka_err2name(@rdkafka_response).downcase
       if code[0] == "_"
@@ -16,10 +22,14 @@ def code
       end
     end
 
+    # Human readable representation of this error.
+    # @return [String]
     def to_s
       "#{Rdkafka::FFI.rd_kafka_err2str(@rdkafka_response)} (#{code})"
     end
 
+    # Whether this error indicates the partition is EOF.
+    # @return [Boolean]
     def is_partition_eof?
       code == :partition_eof
     end

lib/rdkafka/producer.rb

@@ -25,7 +25,7 @@ def close
       @polling_thread.join
     end
 
-    # Produces a message to a Kafka topic. The message is added to rdkafka's queue, call wait on the returned delivery handle to make sure it is delivered.
+    # Produces a message to a Kafka topic. The message is added to rdkafka's queue, call `wait` on the returned delivery handle to make sure it is delivered.
     #
     # When no partition is specified the underlying Kafka library picks a partition based on the key. If no key is specified, a random partition will be used.
     # When a timestamp is provided this is used instead of the autogenerated timestamp.