[ https://issues.apache.org/jira/browse/KAFKA-5228?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Matthias J. Sax updated KAFKA-5228: ----------------------------------- Fix Version/s: 0.11.0.0 Status: Patch Available (was: Open) > 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: 0.11.0.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 (v6.3.15#6346)