kafka-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From guozh...@apache.org
Subject kafka git commit: MINOR: fix typos and incorrect docs
Date Wed, 09 Nov 2016 18:41:32 GMT
Repository: kafka
Updated Branches:
  refs/heads/trunk 6dbe202b6 -> 8ab8f37b4


MINOR: fix typos and incorrect docs

Author: Xavier Léauté <xavier@confluent.io>

Reviewers: Matthias J. Sax, Guozhang Wang

Closes #2112 from xvrl/minor-doc-fixes


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

Branch: refs/heads/trunk
Commit: 8ab8f37b43e3274ad0d8fb3883e3f432992058ba
Parents: 6dbe202
Author: Xavier Léauté <xavier@confluent.io>
Authored: Wed Nov 9 10:41:29 2016 -0800
Committer: Guozhang Wang <wangguoz@gmail.com>
Committed: Wed Nov 9 10:41:29 2016 -0800

----------------------------------------------------------------------
 .../java/org/apache/kafka/streams/kstream/ForeachAction.java     | 2 +-
 .../main/java/org/apache/kafka/streams/kstream/Transformer.java  | 4 ++--
 .../src/main/java/org/apache/kafka/streams/kstream/Windows.java  | 4 ++--
 3 files changed, 5 insertions(+), 5 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/kafka/blob/8ab8f37b/streams/src/main/java/org/apache/kafka/streams/kstream/ForeachAction.java
----------------------------------------------------------------------
diff --git a/streams/src/main/java/org/apache/kafka/streams/kstream/ForeachAction.java b/streams/src/main/java/org/apache/kafka/streams/kstream/ForeachAction.java
index b3e3169..4c773c9 100644
--- a/streams/src/main/java/org/apache/kafka/streams/kstream/ForeachAction.java
+++ b/streams/src/main/java/org/apache/kafka/streams/kstream/ForeachAction.java
@@ -22,7 +22,7 @@ package org.apache.kafka.streams.kstream;
  * The {@link ForeachAction} interface for performing an action on a key-value pair.
  * Note that this action is stateless. If stateful processing is required, consider
  * using {@link KStream#transform(TransformerSupplier, String...)} or
- * {@link KStream#process(ProcessorSupplier, String...)} instead.
+ * {@link KStream#process(org.apache.kafka.streams.processor.ProcessorSupplier, String...)}
instead.
  *
  * @param <K>   original key type
  * @param <V>   original value type

http://git-wip-us.apache.org/repos/asf/kafka/blob/8ab8f37b/streams/src/main/java/org/apache/kafka/streams/kstream/Transformer.java
----------------------------------------------------------------------
diff --git a/streams/src/main/java/org/apache/kafka/streams/kstream/Transformer.java b/streams/src/main/java/org/apache/kafka/streams/kstream/Transformer.java
index 239854b..e9363e8 100644
--- a/streams/src/main/java/org/apache/kafka/streams/kstream/Transformer.java
+++ b/streams/src/main/java/org/apache/kafka/streams/kstream/Transformer.java
@@ -20,7 +20,7 @@ package org.apache.kafka.streams.kstream;
 import org.apache.kafka.streams.processor.ProcessorContext;
 
 /**
- * A stateful {@link Transformer} interface for transform a key-value pair into a new value.
+ * A stateful {@link Transformer} interface to transform a key-value pair into a new value.
  *
  * @param <K>   key type
  * @param <V>   value type
@@ -49,7 +49,7 @@ public interface Transformer<K, V, R> {
     R transform(K key, V value);
 
     /**
-     * Perform any periodic operations and possibly generate a key, if this processor {@link
ProcessorContext#schedule(long) schedule itself} with the context
+     * Perform any periodic operations and possibly generate a key, if this processor {@link
ProcessorContext#schedule(long) schedules itself} with the context
      * during {@link #init(ProcessorContext) initialization}.
      *
      * @param timestamp the stream time when this method is being called

http://git-wip-us.apache.org/repos/asf/kafka/blob/8ab8f37b/streams/src/main/java/org/apache/kafka/streams/kstream/Windows.java
----------------------------------------------------------------------
diff --git a/streams/src/main/java/org/apache/kafka/streams/kstream/Windows.java b/streams/src/main/java/org/apache/kafka/streams/kstream/Windows.java
index 5a4f0d4..dbc52a8 100644
--- a/streams/src/main/java/org/apache/kafka/streams/kstream/Windows.java
+++ b/streams/src/main/java/org/apache/kafka/streams/kstream/Windows.java
@@ -64,9 +64,9 @@ public abstract class Windows<W extends Window> {
     }
 
     /**
-     * Return the window maintain duration in milliseconds of system time.
+     * Return the window maintain duration in milliseconds of streams time.
      *
-     * @return the window maintain duration in milliseconds of system time
+     * @return the window maintain duration in milliseconds of streams time
      */
     public long maintainMs() {
         return this.maintainDurationMs;


Mime
View raw message