Skip to content

2.x: fix/clarify the Observable class' javadoc#5432

Merged
akarnokd merged 2 commits intoReactiveX:2.xfrom
akarnokd:ObservableJavadocClarifications
Jun 23, 2017
Merged

2.x: fix/clarify the Observable class' javadoc#5432
akarnokd merged 2 commits intoReactiveX:2.xfrom
akarnokd:ObservableJavadocClarifications

Conversation

@akarnokd
Copy link
Member

This PR rewords the javadoc of the Observable class a bit and adds a couple of extra clarifying sentences.

@akarnokd akarnokd added this to the 2.2 milestone Jun 21, 2017
* therefore accept general {@code ObservableSource}s directly and allow direct interoperation with other
* Reactive-Streams implementations.
* Many operators in the class accept {@code ObservableSource}(s), the base reactive interface
* for such non-backpressured flows, which {@code Observable} itself extends as well.
Copy link
Collaborator

Choose a reason for hiding this comment

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

s/extends/implements

Copy link
Member Author

Choose a reason for hiding this comment

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

Ok.

* <p>
* The {@code Observable} follows the protocol
* <pre><code>
* onSubscribe onNext* (onError | onComplete)?
Copy link
Collaborator

@vanniktech vanniktech Jun 21, 2017

Choose a reason for hiding this comment

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

maybe onNext(T)*?

Copy link
Member Author

Choose a reason for hiding this comment

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

The parameters are omitted to avoid conflict with the regexp-like pattern

* <pre><code>
* Disposable d = Observable.just("Hello world!")
* .delay(1, TimeUnit.SECONDS)
* .subscribeWith(new DisposableObserver&lt;String>() {
Copy link
Collaborator

Choose a reason for hiding this comment

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

s/>/&gt;

Copy link
Member Author

Choose a reason for hiding this comment

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

The closing > doesn't need escaping.

@codecov
Copy link

codecov bot commented Jun 21, 2017

Codecov Report

Merging #5432 into 2.x will increase coverage by 0.05%.
The diff coverage is n/a.

Impacted file tree graph

@@             Coverage Diff              @@
##                2.x    #5432      +/-   ##
============================================
+ Coverage     96.02%   96.07%   +0.05%     
- Complexity     5787     5801      +14     
============================================
  Files           631      631              
  Lines         41291    41291              
  Branches       5742     5742              
============================================
+ Hits          39648    39669      +21     
+ Misses          650      635      -15     
+ Partials        993      987       -6
Impacted Files Coverage Δ Complexity Δ
src/main/java/io/reactivex/Observable.java 100% <ø> (ø) 506 <0> (ø) ⬇️
...ternal/operators/flowable/FlowableSubscribeOn.java 91.52% <0%> (-6.78%) 2% <0%> (ø)
...vex/internal/operators/single/SingleTakeUntil.java 86.88% <0%> (-6.56%) 2% <0%> (ø)
...nternal/operators/parallel/ParallelSortedJoin.java 89.13% <0%> (-5.8%) 2% <0%> (ø)
.../internal/operators/maybe/MaybeTakeUntilMaybe.java 93.87% <0%> (-4.09%) 2% <0%> (ø)
...rnal/operators/completable/CompletableTimeout.java 94% <0%> (-4%) 2% <0%> (ø)
...perators/single/SingleFlatMapIterableFlowable.java 95.83% <0%> (-2.5%) 2% <0%> (ø)
...ernal/operators/flowable/FlowableFromIterable.java 91.97% <0%> (-2.14%) 5% <0%> (ø)
...activex/internal/schedulers/ExecutorScheduler.java 94.59% <0%> (-2.03%) 9% <0%> (ø)
...nternal/operators/observable/ObservableWindow.java 98% <0%> (-2%) 3% <0%> (ø)
... and 37 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 7b3172b...5ebc725. Read the comment docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants