kafka-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From guozh...@apache.org
Subject kafka git commit: KAFKA-5918: Fix minor typos and errors in the Kafka Streams turotial
Date Mon, 18 Sep 2017 23:58:11 GMT
Repository: kafka
Updated Branches:
  refs/heads/trunk d0645aaee -> a64fe2ed8


KAFKA-5918: Fix minor typos and errors in the Kafka Streams turotial

I found several minor issues with the Kafka Streams tutorial:
* Some typos
  * "As shown above, it illustrate that the constructed ..." instead of "As shown above, it
illustrate_s_ that the constructed ..."
  * "same as Pipe.java below" instead of "same as Pipe.java _above_"
  * Wrong class name in the `LineSplit` example
* Incorrect imports for the code examples
  * Missing `import org.apache.kafka.streams.kstream.KStream;` in `LineSplit` and `WordCount`
example
* Unnecessary (and potentially confusing) split by whitespaces in the `WorkCount` class (the
split into words happened already in `LineSplit`)

Author: Jakub Scholz <www@scholzj.com>

Reviewers: Matthias J. Sax <matthias@confluent.io>, Guozhang Wang <wangguoz@gmail.com>

Closes #3883 from scholzj/stream-tutorial-typos


Project: http://git-wip-us.apache.org/repos/asf/kafka/repo
Commit: http://git-wip-us.apache.org/repos/asf/kafka/commit/a64fe2ed
Tree: http://git-wip-us.apache.org/repos/asf/kafka/tree/a64fe2ed
Diff: http://git-wip-us.apache.org/repos/asf/kafka/diff/a64fe2ed

Branch: refs/heads/trunk
Commit: a64fe2ed88642bdd6531540e3d67f958deca2891
Parents: d0645aa
Author: Jakub Scholz <www@scholzj.com>
Authored: Tue Sep 19 07:58:06 2017 +0800
Committer: Guozhang Wang <wangguoz@gmail.com>
Committed: Tue Sep 19 07:58:06 2017 +0800

----------------------------------------------------------------------
 docs/streams/tutorial.html | 10 ++++++----
 1 file changed, 6 insertions(+), 4 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/kafka/blob/a64fe2ed/docs/streams/tutorial.html
----------------------------------------------------------------------
diff --git a/docs/streams/tutorial.html b/docs/streams/tutorial.html
index 859a303..d8aef84 100644
--- a/docs/streams/tutorial.html
+++ b/docs/streams/tutorial.html
@@ -186,7 +186,7 @@
     </pre>
 
     <p>
-        As shown above, it illustrate that the constructed topology has two processor nodes,
a source node <code>KSTREAM-SOURCE-0000000000</code> and a sink node <code>KSTREAM-SINK-0000000001</code>.
+        As shown above, it illustrates that the constructed topology has two processor nodes,
a source node <code>KSTREAM-SOURCE-0000000000</code> and a sink node <code>KSTREAM-SINK-0000000001</code>.
         <code>KSTREAM-SOURCE-0000000000</code> continuously read records from
Kafka topic <code>streams-plaintext-input</code> and pipe them to its downstream
node <code>KSTREAM-SINK-0000000001</code>;
         <code>KSTREAM-SINK-0000000001</code> will write each of its received
record in order to another Kafka topic <code>streams-pipe-output</code>
         (the <code>--&gt;</code> and <code>&lt;--</code>
arrows dictates the downstream and upstream processor nodes of this node, i.e. "children"
and "parents" within the topology graph).
@@ -320,7 +320,7 @@
     </p>
 
     <pre class="brush: java;">
-        public class Pipe {
+        public class LineSplit {
 
             public static void main(String[] args) throws Exception {
                 Properties props = new Properties();
@@ -405,6 +405,7 @@
         import org.apache.kafka.streams.StreamsBuilder;
         import org.apache.kafka.streams.StreamsConfig;
         import org.apache.kafka.streams.Topology;
+        import org.apache.kafka.streams.kstream.KStream;
 
         import java.util.Arrays;
         import java.util.Properties;
@@ -429,7 +430,7 @@
                 final KafkaStreams streams = new KafkaStreams(topology, props);
                 final CountDownLatch latch = new CountDownLatch(1);
 
-                // ... same as Pipe.java below
+                // ... same as Pipe.java above
             }
         }
     </pre>
@@ -566,6 +567,7 @@
         import org.apache.kafka.streams.StreamsBuilder;
         import org.apache.kafka.streams.StreamsConfig;
         import org.apache.kafka.streams.Topology;
+        import org.apache.kafka.streams.kstream.KStream;
 
         import java.util.Arrays;
         import java.util.Locale;
@@ -593,7 +595,7 @@
                 final KafkaStreams streams = new KafkaStreams(topology, props);
                 final CountDownLatch latch = new CountDownLatch(1);
 
-                // ... same as Pipe.java below
+                // ... same as Pipe.java above
             }
         }
     </pre>


Mime
View raw message