Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Removes a partial sentence in the javadoc #370

Merged
merged 1 commit into from
May 29, 2017
Merged

Removes a partial sentence in the javadoc #370

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion tck/src/main/java/org/reactivestreams/tck/PublisherVerification.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,9 @@ public long maxElementsFromPublisher() {

/**
* Override and return {@code true} in order to skip executing tests marked as {@code Stochastic}.
* Such tests MAY sometimes fail even though the impl
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Or simply paraphrase the docs from tck/README:

Stochastic tests can yield false positives ("be green") even if for some case, the given implementation may violate the tested behaviour. If for some reason, a stochastic test fails for your implementation, yet you are confident the implementation is correct you can disable them using this flag. Please contact the working group on /~https://github.com/reactive-streams/reactive-streams-jvm in case you encounter such issue with the tests.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See /~https://github.com/reactive-streams/reactive-streams-jvm/tree/master/tck#test-types-explained

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point. I'll add:

"Stochastic in this case means that the Rule is impossible or infeasible to deterministically verify— usually this means that this test case can yield false positives ("be green") even if for some case, the given implementation may violate the tested behaviour."

* Stochastic in this case means that the Rule is impossible or infeasible to deterministically verify—
* usually this means that this test case can yield false positives ("be green") even if for some case,
* the given implementation may violate the tested behaviour.
*/
public boolean skipStochasticTests() {
return false;
Expand Down