[
https://issues.apache.org/jira/browse/KAFKA-5228?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16341422#comment-16341422
]
ASF GitHub Bot commented on KAFKA-5228:
---------------------------------------
guozhangwang closed pull request #3047: KAFKA-5228: Revisit Streams DSL JavaDocs
URL: https://github.com/apache/kafka/pull/3047
This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:
As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):
diff --git
a/streams/src/main/java/org/apache/kafka/streams/kstream/KStream.java
b/streams/src/main/java/org/apache/kafka/streams/kstream/KStream.java
index bb37af81d1d..aa304e4a44c 100644
--- a/streams/src/main/java/org/apache/kafka/streams/kstream/KStream.java
+++ b/streams/src/main/java/org/apache/kafka/streams/kstream/KStream.java
@@ -1540,9 +1540,9 @@ void process(final ProcessorSupplier<? super K, ? super
V> processorSupplier,
*
* @param table the {@link KTable} to be joined with this stream
* @param joiner a {@link ValueJoiner} that computes the join result for
a pair of matching records
- * @param keySerde key serdes for materializing this stream.
+ * @param keySerde key serdes for materializing this ({@link KStream}
input) stream
* If not specified the default serdes defined in the
configs will be used
- * @param valSerde value serdes for materializing this stream,
+ * @param valSerde value serdes for materializing this ({@link KStream}
input) stream,
* if not specified the default serdes defined in the
configs will be used
* @param <VT> the value type of the table
* @param <VR> the value type of the result stream
@@ -1699,9 +1699,9 @@ void process(final ProcessorSupplier<? super K, ? super
V> processorSupplier,
*
* @param table the {@link KTable} to be joined with this stream
* @param joiner a {@link ValueJoiner} that computes the join result for
a pair of matching records
- * @param keySerde key serdes for materializing this stream.
+ * @param keySerde key serdes for materializing this ({@link KStream}
input) stream
* If not specified the default serdes defined in the
configs will be used
- * @param valSerde value serdes for materializing this stream,
+ * @param valSerde value serdes for materializing this ({@link KStream}
input) stream,
* if not specified the default serdes defined in the
configs will be used
* @param <VT> the value type of the table
* @param <VR> the value type of the result stream
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
> 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
> Assignee: Jeyhun Karimov
> Priority: Trivial
> Labels: beginner, documentation, newbie
> Fix For: 1.1.0
>
>
> 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
(v7.6.3#76005)
