cadonna commented on a change in pull request #10651:
URL: https://github.com/apache/kafka/pull/10651#discussion_r634203662
##########
File path: docs/streams/developer-guide/app-reset-tool.html
##########
@@ -78,18 +78,17 @@
<h2>Step 1: Run the application reset tool<a class="headerlink"
href="#step-1-run-the-application-reset-tool" title="Permalink to this
headline"></a></h2>
<p>Invoke the application reset tool from the command line</p>
<p>Warning! This tool makes irreversible changes to your
application. It is strongly recommended that you run this once with <code
class="docutils literal"><span class="pre">--dry-run</span></code> to preview
your changes before making them.</p>
- <div class="highlight-bash"><div
class="highlight"><pre><span></span><code><path-to-kafka>/bin/kafka-streams-application-reset</code></pre></div>
- </div>
+ <pre class="line-numbers"><code
class="language-bash"><path-to-kafka>/bin/kafka-streams-application-reset</code></pre>
<p>The tool accepts the following parameters:</p>
- <div class="highlight-bash"><div
class="highlight"><pre><span>Option</span><code> <span class="o">(</span>*
<span class="o">=</span> required<span class="o">)</span>
Description
+ <pre class="line-numbers"><code class="language-bash">Option (* =
required) Description
Review comment:
Class `language-bash` renders the text with strange colors, e.g., the
keyword "file" which is not a keyword here. Since this is actually not a bash
script code, I think we leave it as plain monospaced text.
##########
File path: docs/streams/developer-guide/dsl-api.html
##########
@@ -2542,21 +2501,22 @@ <h5><a class="toc-backref" href="#id34">KTable-KTable
Foreign-Key
<p class="first">Performs a foreign-key LEFT
JOIN of this
table with another table. <a class="reference
external"
href="/%7B%7Bversion%7D%7D/javadoc/org/apache/kafka/streams/kstream/KTable.html#leftJoin-org.apache.kafka.streams.kstream.KTable-org.apache.kafka.streams.kstream.ValueJoiner-">(details)</a></p>
- <div class="highlight-java">
- <div class="highlight">
- <pre><span></span><span
class="n">KTable</span><span class="o"><</span><span
class="n">String</span><span class="o">,</span> Long<span class="o">></span>
<span class="n">left</span> <span class="o">=</span> <span class="o">...;</span>
- <span class="n">KTable</span><span
class="o"><Long</span><span class="o">,</span> <span
class="n">Double</span><span class="o">></span> <span class="n">right</span>
<span class="o">=</span> <span class="o">...;<br>//This </span><span
class="o"><span class="o"><span class="n">foreignKeyExtractor</span></span>
simply uses the left-value to map to the right-key.<br></span><span
class="o"><span class="n">Function</span><span class="o"><Long</span><span
class="o">,</span> Long<span class="n"></span><span class="o">></span> <span
class="n">foreignKeyExtractor</span> <span class="o">=</span> <span
class="o">(x) -> x;</span><br><br></span><span class="c1">// Java 8+
example, using lambda expressions</span>
- <span class="n">KTable</span><span class="o"><</span><span
class="n">String</span><span class="o">,</span> <span
class="n">String</span><span class="o">></span> <span
class="n">joined</span> <span class="o">=</span> <span
class="n">left</span><span class="o">.</span><span class="na">join</span><span
class="o">(</span><span class="n">right</span><span class="o">,</span><br>
<span class="o"><span class="n">foreignKeyExtractor,</span></span>
- <span class="o">(</span><span
class="n">leftValue</span><span class="o">,</span> <span
class="n">rightValue</span><span class="o">)</span> <span
class="o">-></span> <span class="s">"left="</span> <span class="o">+</span>
<span class="n">leftValue</span> <span class="o">+</span> <span class="s">",
right="</span> <span class="o">+</span> <span class="n">rightValue</span> <span
class="cm">/* ValueJoiner */</span>
- <span class="o">);</span></code></pre>
- </div>
- </div>
+ <pre class="line-numbers"><code
class="language-java">KTable<String, Long> left = ...;
+ KTable<Long, Double> right = ...;
+//This foreignKeyExtractor simply uses the left-value to map to the right-key.
+Function<Long, Long> foreignKeyExtractor = (x) -> x;
+
+// Java 8+ example, using lambda expressions
+ KTable<String, String> joined = left.join(right,
+ foreignKeyExtractor,
Review comment:
Could you please put `foreignKeyExtractor` on the previous line or
indent it so that it is at the same column as `right`?
##########
File path: docs/streams/developer-guide/dsl-api.html
##########
@@ -3207,15 +3161,14 @@ <h5><a class="toc-backref" href="#id34">KTable-KTable
Foreign-Key
terminology in academic literature, where the
semantics of sliding windows are different to those of hopping windows.</p>
</div>
<p>The following code defines a hopping window with a
size of 5 minutes and an advance interval of 1 minute:</p>
- <div class="highlight-java"><div
class="highlight"><pre><span></span><span class="kn">import</span> <span
class="nn">java.time.Duration</span><span class="o">;</span>
-<span class="kn">import</span> <span
class="nn">org.apache.kafka.streams.kstream.TimeWindows</span><span
class="o">;</span>
-
-<span class="c1">// A hopping time window with a size of 5 minutes and an
advance interval of 1 minute.</span>
-<span class="c1">// The window's name -- the string parameter -- is used
to e.g. name the backing state store.</span>
-<span class="kt">Duration</span> <span class="n">windowSizeMs</span> <span
class="o">=</span> <span class="n">Duration</span><span class="o">.</span><span
class="na">ofMinutes</span><span class="o">(</span><span
class="mi">5</span><span class="o">);</span>
-<span class="kt">Duration</span> <span class="n">advanceMs</span> <span
class="o">=</span> <span class="n">Duration</span><span
class="o">.</span><span class="na">ofMinutes</span><span
class="o">(</span><span class="mi">1</span><span class="o">);</span>
-<span class="n">TimeWindows</span><span class="o">.</span><span
class="na">of</span><span class="o">(</span><span
class="n">windowSizeMs</span><span class="o">).</span><span
class="na">advanceBy</span><span class="o">(</span><span
class="n">advanceMs</span><span class="o">);</span></code></pre></div>
- </div>
+ <pre class="line-numbers"><code
class="language-java">import java.time.Duration;
+import org.apache.kafka.streams.kstream.TimeWindows;
+
+// A hopping time window with a size of 5 minutes and an advance interval of 1
minute.
+// The window's name -- the string parameter -- is used to e.g. name the
backing state store.
+Duration windowSizeMs = Duration.ofMinutes(5);
+Duration advanceMs = Duration.ofMinutes(1);
Review comment:
Could you fix the indentation here to `Duration advanceMs =
Duration.ofMinutes(1);`?
##########
File path: docs/streams/developer-guide/dsl-api.html
##########
@@ -2482,21 +2440,22 @@ <h5><a class="toc-backref" href="#id34">KTable-KTable
Foreign-Key
KTable that represents the "current"
result of the join.
<a class="reference external"
href="/%7B%7Bversion%7D%7D/javadoc/org/apache/kafka/streams/kstream/KTable.html#join-org.apache.kafka.streams.kstream.KTable-org.apache.kafka.streams.kstream.ValueJoiner-">(details)</a></p>
- <div class="highlight-java">
- <div class="highlight">
- <pre><span></span><span
class="n">KTable</span><span class="o"><</span><span
class="n">String</span><span class="o">,</span> Long<span class="o">></span>
<span class="n">left</span> <span class="o">=</span> <span class="o">...;</span>
- <span class="n">KTable</span><span
class="o"><Long</span><span class="o">,</span> <span
class="n">Double</span><span class="o">></span> <span class="n">right</span>
<span class="o">=</span> <span class="o">...;<br>//This </span><span
class="o"><span class="o"><span class="n">foreignKeyExtractor</span></span>
simply uses the left-value to map to the right-key.<br></span><span
class="o"><span class="n">Function</span><span class="o"><Long</span><span
class="o">,</span> Long<span class="n"></span><span class="o">></span> <span
class="n">foreignKeyExtractor</span> <span class="o">=</span> <span
class="o">(x) -> x;</span><br><br></span><span class="c1">// Java 8+
example, using lambda expressions</span>
- <span class="n">KTable</span><span class="o"><</span><span
class="n">String</span><span class="o">,</span> <span
class="n">String</span><span class="o">></span> <span
class="n">joined</span> <span class="o">=</span> <span
class="n">left</span><span class="o">.</span><span class="na">join</span><span
class="o">(</span><span class="n">right</span><span class="o">,</span><br>
<span class="o"><span class="n">foreignKeyExtractor,</span></span>
- <span class="o">(</span><span
class="n">leftValue</span><span class="o">,</span> <span
class="n">rightValue</span><span class="o">)</span> <span
class="o">-></span> <span class="s">"left="</span> <span class="o">+</span>
<span class="n">leftValue</span> <span class="o">+</span> <span class="s">",
right="</span> <span class="o">+</span> <span class="n">rightValue</span> <span
class="cm">/* ValueJoiner */</span>
- <span class="o">);</span></code></pre>
- </div>
- </div>
+ <pre class="line-numbers"><code
class="language-java">KTable<String, Long> left = ...;
+ KTable<Long, Double> right = ...;
+//This foreignKeyExtractor simply uses the left-value to map to the right-key.
+Function<Long, Long> foreignKeyExtractor = (x) -> x;
+
+// Java 8+ example, using lambda expressions
+ KTable<String, String> joined = left.join(right,
+ foreignKeyExtractor,
Review comment:
Could you please put `foreignKeyExtractor` on the previous line or
indent it so that it is at the same column as `right`?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to 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
