Indicate that a subset of these rules have breaking behavior

PicnicSupermarket · Nov 1, 2024 · 374db08 · 374db08
1 parent 8f803e0
commit 374db08
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/error-prone-contrib/src/main/java/tech/picnic/errorprone/refasterrules/ReactorRules.java b/error-prone-contrib/src/main/java/tech/picnic/errorprone/refasterrules/ReactorRules.java
@@ -1772,6 +1772,9 @@ StepVerifier.FirstStep<? extends T> after(Flux<T> flux) {
    * Prefer {@link StepVerifier.LastStep#verify()} over a dangling {@link
    * StepVerifier#verifyThenAssertThat()}.
    */
+  // XXX: This rule may break existing code. We want to explicitly nudge towards using {@link
+  // StepVerifier.Step#assertNext(Consumer)} or {@link StepVerifier.Step#expectNext(Object)}
+  // together with {@link Step#verifyComplete()}.
   static final class StepVerifierVerify {
     @BeforeTemplate
     StepVerifier.Assertions before(StepVerifier stepVerifier) {