From b1a8a062332b301ca05be740699862f23d9b540a Mon Sep 17 00:00:00 2001
From: Edward Samson <edward@samson.ph>
Date: Wed, 9 Jan 2019 10:19:39 +0800
Subject: [PATCH] Doc clarification on returning `null` from
 RecordTranslator.apply()

According to KafkaSpout implementation, record is discarded if
Builder.setEmitNullTuples is set to `false`, instead of `true`.
---
 .../java/org/apache/storm/kafka/spout/RecordTranslator.java    | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/external/storm-kafka-client/src/main/java/org/apache/storm/kafka/spout/RecordTranslator.java b/external/storm-kafka-client/src/main/java/org/apache/storm/kafka/spout/RecordTranslator.java
index c4a357205bb..6361c90278a 100644
--- a/external/storm-kafka-client/src/main/java/org/apache/storm/kafka/spout/RecordTranslator.java
+++ b/external/storm-kafka-client/src/main/java/org/apache/storm/kafka/spout/RecordTranslator.java
@@ -36,7 +36,8 @@ public interface RecordTranslator<K, V> extends Serializable, Func<ConsumerRecor
      * @param record the record to translate
      * @return the objects in the tuple.  Return a {@link KafkaTuple}
      *     if you want to route the tuple to a non-default stream.
-     *     Return null to discard an invalid {@link ConsumerRecord} if {@link Builder#setEmitNullTuples(boolean)} is set to true
+     *     Return {@code null} to discard an invalid {@link ConsumerRecord}
+     *     if {@link Builder#setEmitNullTuples(boolean)} is set to {@code false}.
      */
     List<Object> apply(ConsumerRecord<K,V> record);