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

3.x: Single incorrect or missing images (tracking issue) #5788

Closed
68 tasks done
akarnokd opened this issue Jan 5, 2018 · 10 comments · Fixed by #6668
Closed
68 tasks done

3.x: Single incorrect or missing images (tracking issue) #5788

akarnokd opened this issue Jan 5, 2018 · 10 comments · Fixed by #6668

Comments

@akarnokd
Copy link
Member

akarnokd commented Jan 5, 2018

  • amb: missing diagram
  • ambArray: missing diagram
  • concat(arg): missing diagram
  • concat(s1..s4): add 3rd and 4th source, indicate backpressure
  • concatArray: missing diagram
  • concatArrayEager: missing diagram
  • concatEager: missing diagram
  • create: missing diagram
  • defer: missing diagram
  • error(Callable): missing diagram
  • error(Throwable): indicate error in the box
  • fromCallable: missing diagram
  • fromPublisher: missing diagram
  • fromObservable: missing diagram
  • merge: missing diagram
  • merge(SingleSource<SingleSource<T>>): indicate main element is a SingleSource
  • merge(s1..s4): add 3rd and 4th source, indicate backpressure
  • mergeDelayError: Iterable/Publisher missing diagrams, S2,S3,S4 wrong diagrams
  • never: missing diagram
  • timer: missing diagram
  • equals: missing diagram
  • unsafeCreate: missing diagram
  • using: missing diagram
  • wrap: missing diagram
  • ambWith: missing diagram
  • as: missing diagram
  • hide: missing diagram
  • compose: missing diagram
  • cache: missing diagram
  • cast: missing diagram
  • delay: missing diagram
  • delaySubscription: missing diagram
  • dematerialize: missing diagram
  • doAfterSuccess: missing diagram
  • doAfterTerminate: indicate error case
  • doFinally: missing diagram
  • doOnSubscibe: missing diagram
  • doOnSuccess: missing diagram
  • doOnEvent: missing diagram
  • doOnError: missing diagram
  • doOnDispose: missing diagram
  • filter: one source item, indicate both true and false outcomes
  • flatMapPublisher: operator name
  • blockingGet: missing diagram
  • lift: missing diagram
  • contains: missing diagram
  • mergeWith: indicate backpressure
  • onErrorReturn: indicate item is the result of a function call with the original error
  • onErrorReturnItem: use the previous onErrorReturn diagram, change name in box
  • onErrorResumeNext: diagram should have one item and no complete marker
  • onErrorResumeWith: operator name
  • onTerminateDetach: missing diagram
  • repeat: missing diagram
  • repeatWhen: missing diagram
  • repeatUntil: missing diagram
  • retry: missing diagram
  • retryWhen: missing diagram
  • subscribe: missing diagram
  • subscribeWith: missing diagram?
  • takeUntil: fix item count in main and other sources, indicate all other signal types
  • timeout: missing diagram
  • to: missing diagram
  • toCompletable: diagram is stretched
  • toFlowable: operator name in box, indicate backpressure
  • toFuture: indicate Future, remove the blocking text
  • toMaybe: operator name in box, indicate both outcomes with proper signal types
  • unsubscribeOn: missing diagram
  • test: missing diagram?
@VeskoI
Copy link
Contributor

VeskoI commented Apr 30, 2018

I see most marbles in the JavaDoc live under this folder: https://raw.githubusercontent.com/wiki/ReactiveX/RxJava/images/rx-operators/. Are other locations accepted - e.g. can I upload it in Google Drive for example and open a PR with the updated path in the JavaDoc directly? Here's a few I created:

single_dofinally
single_doondispose
single_doonerror
single_doonsubscribe
single_doonsuccess

@akarnokd
Copy link
Member Author

Images have to be hosted by the project. Besides, Google drive tends to change the service terms and images may become inaccessible (I've lost resource location this way in another project).

About your images:

  • doFinally:
    • error should be a red X
    • the dispose case puts the star too close to the time arrow as if it was an output instead of a side-effect
    • I draw disposed flows with dashed lines (example), it would be great here
  • doOnDispose
    • the dispose case puts the star too close to the time arrow as if it was an output instead of a side-effect
    • I draw disposed flows with dashed lines (example), it would be great here
    • unsubscribe should be dispose
  • doOnSubscribe
    • the star should be in between the operator box and the bottom timeline
  • doOnSuccess: OK

@akarnokd
Copy link
Member Author

Updated images from #5987 now in the repository:

doFinally
doOnSuccess
doOnError
doOnDispose
doOnSubscribe

@AarjavP
Copy link

AarjavP commented Jun 11, 2018

how are these made? are there any written guidelines? I can try making some when I have time.

@akarnokd
Copy link
Member Author

akarnokd commented Jun 11, 2018

There is a Mac only OmniGraffle. I'm on Windows and I use Excel shapes and arrows.

@VeskoI
Copy link
Contributor

VeskoI commented Jun 12, 2018

@AarjavP , I used THIS template as a staring point. It's for Inkscape software, which worked nicely on my Mac.

@UMFsimke
Copy link
Contributor

UMFsimke commented Jul 8, 2018

Hi all, can you please tell me is this marble acceptable for the filter operator?

As I haven't contributed to this project so far I would like to take it easy and slow :) Let me know what should I change so that I have a reference for future marbles.

filter

@akarnokd
Copy link
Member Author

akarnokd commented Jul 8, 2018

Not really. There is no | in Single. Please have a look at diagrams above: #5788 (comment)

@UMFsimke
Copy link
Contributor

UMFsimke commented Aug 5, 2018

@akarnokd can we update this issue please? Its getting a bit messy and hard to follow what has been completed.

@akarnokd
Copy link
Member Author

akarnokd commented Aug 5, 2018

@UMFsimke It has been only you lately that worked on this.

@akarnokd akarnokd added the 3.x label Jun 19, 2019
@akarnokd akarnokd modified the milestones: 2.2 backlog, 3.0 Jul 3, 2019
@akarnokd akarnokd removed the 2.x label Oct 10, 2019
@akarnokd akarnokd changed the title 2.x: Single incorrect or missing images (tracking issue) 3.x: Single incorrect or missing images (tracking issue) Oct 10, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants
@akarnokd @VeskoI @UMFsimke @AarjavP and others