From e301854caede5f171ddbc7d64a2214fda69e9e55 Mon Sep 17 00:00:00 2001
From: Glyn Normington <gnormington@pivotal.io>
Date: Tue, 9 Jan 2018 11:14:34 +0000
Subject: [PATCH] Improve documentation of Flux.merge

Avoid talking about "inner sources" or "inner publishers" when there is only
one collection of sources in sight. Reserve the use of the adjective "inner"
for variants of Flux.merge which deal with publishers of publishers.

Also, use the term "sources" instead of "publishers" consistently across the
related variants of Flux.merge.
---
 .../main/java/reactor/core/publisher/Flux.java | 18 +++++++++---------
 1 file changed, 9 insertions(+), 9 deletions(-)

diff --git a/reactor-core/src/main/java/reactor/core/publisher/Flux.java b/reactor-core/src/main/java/reactor/core/publisher/Flux.java
index 329ae3bc3b..fd1290cab3 100644
--- a/reactor-core/src/main/java/reactor/core/publisher/Flux.java
+++ b/reactor-core/src/main/java/reactor/core/publisher/Flux.java
@@ -1166,7 +1166,7 @@ public static <I> Flux<I> merge(Iterable<? extends Publisher<? extends I>> sourc
 
 	/**
 	 * Merge data from {@link Publisher} sequences contained in an array / vararg
-	 * into an interleaved merged sequence. Unlike {@link #concat(Publisher) concat}, inner
+	 * into an interleaved merged sequence. Unlike {@link #concat(Publisher) concat},
 	 * sources are subscribed to eagerly.
 	 * <p>
 	 * <img class="marble" src="https://raw.githubusercontent.com/reactor/reactor-core/v3.1.1.RELEASE/src/docs/marble/merge.png" alt="">
@@ -1188,7 +1188,7 @@ public static <I> Flux<I> merge(Publisher<? extends I>... sources) {
 
 	/**
 	 * Merge data from {@link Publisher} sequences contained in an array / vararg
-	 * into an interleaved merged sequence. Unlike {@link #concat(Publisher) concat}, inner
+	 * into an interleaved merged sequence. Unlike {@link #concat(Publisher) concat},
 	 * sources are subscribed to eagerly.
 	 * <p>
 	 * <img class="marble" src="https://raw.githubusercontent.com/reactor/reactor-core/v3.1.1.RELEASE/src/docs/marble/merge.png" alt="">
@@ -1211,7 +1211,7 @@ public static <I> Flux<I> merge(int prefetch, Publisher<? extends I>... sources)
 
 	/**
 	 * Merge data from {@link Publisher} sequences contained in an array / vararg
-	 * into an interleaved merged sequence. Unlike {@link #concat(Publisher) concat}, inner
+	 * into an interleaved merged sequence. Unlike {@link #concat(Publisher) concat},
 	 * sources are subscribed to eagerly.
 	 * This variant will delay any error until after the rest of the merge backlog has been processed.
 	 * <p>
@@ -1294,7 +1294,7 @@ public static <T> Flux<T> mergeSequentialDelayError(Publisher<? extends Publishe
 
 	/**
 	 * Merge data from {@link Publisher} sequences provided in an array/vararg
-	 * into an ordered merged sequence. Unlike concat, the inner publishers are subscribed to
+	 * into an ordered merged sequence. Unlike concat, sources are subscribed to
 	 * eagerly. Unlike merge, their emitted values are merged into the final sequence in subscription order.
 	 * <p>
 	 * <img class="marble" src="https://raw.githubusercontent.com/reactor/reactor-core/v3.1.1.RELEASE/src/docs/marble/mergesequential.png" alt="">
@@ -1311,7 +1311,7 @@ public static <I> Flux<I> mergeSequential(Publisher<? extends I>... sources) {
 
 	/**
 	 * Merge data from {@link Publisher} sequences provided in an array/vararg
-	 * into an ordered merged sequence. Unlike concat, the inner publishers are subscribed to
+	 * into an ordered merged sequence. Unlike concat, sources are subscribed to
 	 * eagerly. Unlike merge, their emitted values are merged into the final sequence in subscription order.
 	 * <p>
 	 * <img class="marble" src="https://raw.githubusercontent.com/reactor/reactor-core/v3.1.1.RELEASE/src/docs/marble/mergesequential.png" alt="">
@@ -1329,7 +1329,7 @@ public static <I> Flux<I> mergeSequential(int prefetch, Publisher<? extends I>..
 
 	/**
 	 * Merge data from {@link Publisher} sequences provided in an array/vararg
-	 * into an ordered merged sequence. Unlike concat, the inner publishers are subscribed to
+	 * into an ordered merged sequence. Unlike concat, sources are subscribed to
 	 * eagerly. Unlike merge, their emitted values are merged into the final sequence in subscription order.
 	 * This variant will delay any error until after the rest of the mergeSequential backlog
 	 * has been processed.
@@ -1349,7 +1349,7 @@ public static <I> Flux<I> mergeSequentialDelayError(int prefetch, Publisher<? ex
 
 	/**
 	 * Merge data from {@link Publisher} sequences provided in an {@link Iterable}
-	 * into an ordered merged sequence. Unlike concat, the inner publishers are subscribed to
+	 * into an ordered merged sequence. Unlike concat, sources are subscribed to
 	 * eagerly. Unlike merge, their emitted values are merged into the final sequence in subscription order.
 	 * <p>
 	 * <img class="marble" src="https://raw.githubusercontent.com/reactor/reactor-core/v3.1.1.RELEASE/src/docs/marble/mergesequential.png" alt="">
@@ -1366,7 +1366,7 @@ public static <I> Flux<I> mergeSequential(Iterable<? extends Publisher<? extends
 
 	/**
 	 * Merge data from {@link Publisher} sequences provided in an {@link Iterable}
-	 * into an ordered merged sequence. Unlike concat, the inner publishers are subscribed to
+	 * into an ordered merged sequence. Unlike concat, sources are subscribed to
 	 * eagerly (but at most {@code maxConcurrency} sources at a time). Unlike merge, their
 	 * emitted values are merged into the final sequence in subscription order.
 	 * <p>
@@ -1386,7 +1386,7 @@ public static <I> Flux<I> mergeSequential(Iterable<? extends Publisher<? extends
 
 	/**
 	 * Merge data from {@link Publisher} sequences provided in an {@link Iterable}
-	 * into an ordered merged sequence. Unlike concat, the inner publishers are subscribed to
+	 * into an ordered merged sequence. Unlike concat, sources are subscribed to
 	 * eagerly (but at most {@code maxConcurrency} sources at a time). Unlike merge, their
 	 * emitted values are merged into the final sequence in subscription order.
 	 * This variant will delay any error until after the rest of the mergeSequential backlog