You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@kafka.apache.org by "ASF GitHub Bot (JIRA)" <ji...@apache.org> on 2017/05/13 23:42:04 UTC
[jira] [Commented] (KAFKA-5228) Revisit Streams DSL JavaDocs
[ https://issues.apache.org/jira/browse/KAFKA-5228?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16009552#comment-16009552 ]
ASF GitHub Bot commented on KAFKA-5228:
---------------------------------------
GitHub user jeyhunkarimov opened a pull request:
https://github.com/apache/kafka/pull/3047
KAFKA-5228: Revisit Streams DSL JavaDocs
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/jeyhunkarimov/kafka KAFKA-5228
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/kafka/pull/3047.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #3047
----
commit c1ec019b40eba36d659f2bb6261a106340805b6f
Author: Jeyhun Karimov <je...@gmail.com>
Date: 2017-05-13T23:40:37Z
More clarification added to JavaDocs
----
> Revisit Streams DSL JavaDocs
> ----------------------------
>
> Key: KAFKA-5228
> URL: https://issues.apache.org/jira/browse/KAFKA-5228
> Project: Kafka
> Issue Type: Improvement
> Components: streams
> Affects Versions: 0.10.2.1
> Reporter: Matthias J. Sax
> Priority: Trivial
> Labels: beginner, documentation, newbie
>
> We got some user feedback, that is it sometimes not clear from the JavaDocs, if provides {{Serdes}} are for input or output records.
> For example:
> {noformat}
> ...
> * @param keySerde key serdes for materializing this stream.
> * If not specified the default serdes defined in the configs will be used
> * @param valSerde value serdes for materializing this stream,
> * if not specified the default serdes defined in the configs will be used
> ...
> <VT, VR> KStream<K, VR> join(final KTable<K, VT> table,
> final ValueJoiner<? super V, ? super VT, ? extends VR> joiner,
> final Serde<K> keySerde,
> final Serde<V> valSerde);
> {noformat}
> The phrase "for this stream" means the input stream. But it is rather subtle. We should revisit the complete JavaDocs and rephrase the Serde parameter description if required. We should also rename the parameter names (in the example about, maybe from {{keySerde}} to {{inputKStreamKeySerde}})
--
This message was sent by Atlassian JIRA
(v6.3.15#6346)