Uploaded image for project: 'Kafka'
  1. Kafka
  2. KAFKA-5228

Revisit Streams DSL JavaDocs

    XMLWordPrintableJSON

    Details

      Description

      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:

      ...
           * @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);
      

      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)

        Attachments

          Activity

            People

            • Assignee:
              jeyhunkarimov Jeyhun Karimov
              Reporter:
              mjsax Matthias J. Sax
            • Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: