aboutsummaryrefslogtreecommitdiff
path: root/streaming
diff options
context:
space:
mode:
authorzsxwing <zsxwing@gmail.com>2014-11-20 01:13:36 -0800
committerTathagata Das <tathagata.das1565@gmail.com>2014-11-20 01:13:36 -0800
commitb676d9ad347e296929361809b0001c0f5c700514 (patch)
treeabcab7208479432638161a4fc9c1fdd4f0f2be98 /streaming
parente958132a80d202b70976632a51c7e8e4b58d9c4e (diff)
downloadspark-b676d9ad347e296929361809b0001c0f5c700514.tar.gz
spark-b676d9ad347e296929361809b0001c0f5c700514.tar.bz2
spark-b676d9ad347e296929361809b0001c0f5c700514.zip
[SPARK-4481][Streaming][Doc] Fix the wrong description of updateFunc (backport for branch-1.2)
backport for branch-1.2 as per #3356 Author: zsxwing <zsxwing@gmail.com> Closes #3376 from zsxwing/SPARK-4481-branch-1.2 and squashes the following commits: 53b94e8 [zsxwing] Fix the wrong description of updateFunc
Diffstat (limited to 'streaming')
-rw-r--r--streaming/src/main/scala/org/apache/spark/streaming/dstream/PairDStreamFunctions.scala7
1 files changed, 3 insertions, 4 deletions
diff --git a/streaming/src/main/scala/org/apache/spark/streaming/dstream/PairDStreamFunctions.scala b/streaming/src/main/scala/org/apache/spark/streaming/dstream/PairDStreamFunctions.scala
index 9467595d30..f405dda6c7 100644
--- a/streaming/src/main/scala/org/apache/spark/streaming/dstream/PairDStreamFunctions.scala
+++ b/streaming/src/main/scala/org/apache/spark/streaming/dstream/PairDStreamFunctions.scala
@@ -398,10 +398,9 @@ class PairDStreamFunctions[K, V](self: DStream[(K,V)])
* Return a new "state" DStream where the state for each key is updated by applying
* the given function on the previous state of the key and the new values of each key.
* org.apache.spark.Partitioner is used to control the partitioning of each RDD.
- * @param updateFunc State update function. If `this` function returns None, then
- * corresponding state key-value pair will be eliminated. Note, that
- * this function may generate a different a tuple with a different key
- * than the input key. It is up to the developer to decide whether to
+ * @param updateFunc State update function. Note, that this function may generate a different
+ * tuple with a different key than the input key. Therefore keys may be removed
+ * or added in this way. It is up to the developer to decide whether to
* remember the partitioner despite the key being changed.
* @param partitioner Partitioner for controlling the partitioning of each RDD in the new
* DStream