Skip to content

Commit 7a33ecf

Browse files
committed
Fixed javadocs for skipStochasticTests
Fixes #278. Clarified what the stochastic tests are, and what the flag to skip them is provided for.
1 parent 9464664 commit 7a33ecf

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

Diff for: tck/src/main/java/org/reactivestreams/tck/IdentityProcessorVerification.java

+9-1
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,15 @@ public long boundedDepthOfOnNextAndRequestRecursion() {
172172

173173
/**
174174
* Override and return {@code true} in order to skip executing tests marked as {@code Stochastic}.
175-
* Such tests MAY sometimes fail even though the impl
175+
* <p>
176+
* Such tests MAY sometimes pass even when the implementation doesn't implement the requirement correctly. These
177+
* tests are typically testing things that can't be proven by a test, for example, testing for concurrency issues
178+
* like ensuring that two methods are not invoked concurrently. In such cases, the implementation may pass the test
179+
* out of luck.
180+
* <p>
181+
* This flag is provided because for some implementations, the stochastic tests can be expensive to run, and given
182+
* that they emit false positives and so don't actually mean anything, the value from running them may not justify
183+
* the cost.
176184
*/
177185
public boolean skipStochasticTests() {
178186
return false;

0 commit comments

Comments
 (0)