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.

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

2.x: Expand Creating-Observables.md wiki #6131

Merged
merged 1 commit into from
Aug 4, 2018

Conversation

akarnokd
Copy link
Member

@akarnokd akarnokd commented Aug 3, 2018

This PR expands and updates the Creating-Observables.md wiki page to 2.x terminology and feature set.

This also serves as a discussion basis about how to detail the various operators. The PR suggests the following structure:

  • Top outline with links to the family of operators
  • Each operator lists:
    • an availability list for the various reactive types: image available, image not available
    • ReactiveX documentation link if available
    • Short description
    • Example, named as operator example so that the heading generated can be linked to directly (i.e., Creating-Observables.md#justexample.

Related tracking issue: #6132

@codecov
Copy link

codecov bot commented Aug 3, 2018

Codecov Report

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

Impacted file tree graph

@@             Coverage Diff              @@
##                2.x    #6131      +/-   ##
============================================
+ Coverage     98.23%   98.26%   +0.03%     
+ Complexity     6194     6191       -3     
============================================
  Files           667      667              
  Lines         44853    44853              
  Branches       6213     6213              
============================================
+ Hits          44063    44077      +14     
+ Misses          245      233      -12     
+ Partials        545      543       -2
Impacted Files Coverage Δ Complexity Δ
...reactivex/internal/operators/single/SingleAmb.java 96.36% <0%> (-3.64%) 9% <0%> (-1%)
...rnal/operators/flowable/FlowableFlatMapSingle.java 92.93% <0%> (-2.72%) 2% <0%> (ø)
...activex/internal/observers/QueueDrainObserver.java 97.43% <0%> (-2.57%) 21% <0%> (-1%)
...va/io/reactivex/internal/queue/SpscArrayQueue.java 97.61% <0%> (-2.39%) 22% <0%> (-1%)
...a/io/reactivex/internal/util/QueueDrainHelper.java 97.91% <0%> (-2.09%) 56% <0%> (-2%)
.../internal/disposables/ListCompositeDisposable.java 98% <0%> (-2%) 34% <0%> (-1%)
...nternal/operators/parallel/ParallelReduceFull.java 91.08% <0%> (-1.99%) 2% <0%> (ø)
...rnal/operators/observable/ObservableSwitchMap.java 94.68% <0%> (-1.6%) 3% <0%> (ø)
...io/reactivex/subscribers/SerializedSubscriber.java 98.86% <0%> (-1.14%) 26% <0%> (-1%)
...perators/mixed/ObservableSwitchMapCompletable.java 98.94% <0%> (-1.06%) 3% <0%> (ø)
... and 18 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 2274c42...84d53be. Read the comment docs.

akarnokd pushed a commit that referenced this pull request Aug 4, 2018
* Initial clean up for Combining Observables docs

This patch updates the style of the combining observables documentation
to be similar to that of #6131 and adds examples for most of the
operators therein. Refs #6132.

* Address comments
@akarnokd akarnokd merged commit c7f3349 into ReactiveX:2.x Aug 4, 2018
@akarnokd akarnokd deleted the ObservableCreateMdImprove branch August 4, 2018 17:05
Copy link
Collaborator

@vanniktech vanniktech left a comment

Choose a reason for hiding this comment

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

👍

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