Suggestions

PicnicSupermarket · Jan 15, 2022 · ba13b73 · ba13b73
1 parent a30eb0b
commit ba13b73
Showing 1 changed file with 8 additions and 7 deletions.
diff --git a/...prone-contrib/src/main/java/tech/picnic/errorprone/bugpatterns/FluxFlatMapUsageCheck.java b/...prone-contrib/src/main/java/tech/picnic/errorprone/bugpatterns/FluxFlatMapUsageCheck.java
@@ -28,12 +28,12 @@
  * Flux#flatMapSequential(Function)}.
  *
  * <p>{@link Flux#flatMap(Function)} and {@link Flux#flatMapSequential(Function)} eagerly perform up
- * to {@link reactor.util.concurrent.Queues#SMALL_BUFFER_SIZE} subscriptions, interleaving the
- * results as they are emitted. In most cases {@link Flux#concatMap(Function)} should be preferred,
- * as it produces consistent results and avoids potentially saturating the thread pool on which
- * subscription happens. If {@code concatMap}'s single-subscription semantics are undesirable one
- * should invoke a {@code flatMap} or {@code flatMapSequential} overload with an explicit
- * concurrency level.
+ * to {@link reactor.util.concurrent.Queues#SMALL_BUFFER_SIZE} subscriptions. Additionally, the
+ * former interleaves values as they are emitted, yielding nondeterministic results. In most cases
+ * {@link Flux#concatMap(Function)} should be preferred, as it produces consistent results and
+ * avoids potentially saturating the thread pool on which subscription happens. If {@code
+ * concatMap}'s single-subscription semantics are undesirable one should invoke a {@code flatMap} or
+ * {@code flatMapSequential} overload with an explicit concurrency level.
  *
  * <p>NB: The rarely-used overload {@link Flux#flatMap(Function, Function, Supplier)} is not flagged
  * by this check because there is no clear alternative to point to.
@@ -42,7 +42,8 @@
 @BugPattern(
     name = "FluxFlatMapUsage",
     summary =
-        "`Flux#flatMap` and `Flux#flatMapSequential` have subtle semantics; please use `Flux#concatMap` or explicitly specify the desired amount of concurrency",
+        "`Flux#flatMap` and `Flux#flatMapSequential` have subtle semantics; "
+            + "please use `Flux#concatMap` or explicitly specify the desired amount of concurrency",
     linkType = LinkType.NONE,
     severity = SeverityLevel.ERROR,
     tags = StandardTags.LIKELY_ERROR)