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

Documetation points to some nonexistent marble diagrams #5067

Closed
Stephan202 opened this issue Feb 3, 2017 · 4 comments
Closed

Documetation points to some nonexistent marble diagrams #5067

Stephan202 opened this issue Feb 3, 2017 · 4 comments

Comments

@Stephan202
Copy link
Contributor

Noticed this while reading some JavaDoc in the context of a 1.2.6 -> 2.0.5 upgrade. I wrote the following script to list all JavaDoc-referenced PNGs which do not yield an HTTP 200 response when resolved:

#!/usr/bin/env bash

find . -name '*.java' -print0 \
  | xargs -0 grep '^\s*\*' \
  | grep -oP 'https.*?\.png' \
  | sort -u \
  | while read -r I; do
      curl -L -o /dev/null -s -w "%{http_code} ${I}\n" "${I}"
    done \
  | grep -v '^200'

And then applied it to the 2.x branch (rev 0a2610e). The output is:

404 https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/Completable.toObservable.png
404 https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/Maybe.concat.png
404 https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/Maybe.error.png
404 https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/Maybe.flatMapCompletable.png
404 https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/Maybe.flatMap.png
404 https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/Maybe.flatMapPublisher.png
404 https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/Maybe.flatMapSingle.png
404 https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/Maybe.just.png
404 https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/Maybe.map.png
404 https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/Maybe.merge.oo.png
404 https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/Maybe.merge.png
404 https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/Maybe.observeOn.png
404 https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/Maybe.subscribeOn.png
404 https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/onExceptionResumeNextViaMaybe.png
404 https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/S.BehaviorProcessor.png
404 https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/Single.flatMapCompletable.png
404 https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/Single.flatMapMaybe.png
@akarnokd
Copy link
Member

akarnokd commented Feb 4, 2017

Thanks, I'll draw them next week.

@akarnokd
Copy link
Member

akarnokd commented Feb 6, 2017

Completable.toObservable.png
image

Maybe.concat.png
image

Maybe.error.png
image

Maybe.flatMapCompletable.png
image

Maybe.flatMap.png
image

Maybe.flatMapPublisher.png
image

Maybe.flatMapSingle.png
image

Maybe.just.png
image

Maybe.map.png
image

Maybe.merge.oo.png
image

Maybe.merge.png
image

Maybe.observeOn.png
image

Maybe.subscribeOn.png
image

onExceptionResumeNextViaMaybe.png
image

S.BehaviorProcessor.png
image

Single.flatMapCompletable.png
image

Single.flatMapMaybe.png
image

@akarnokd akarnokd closed this as completed Feb 6, 2017
@akarnokd
Copy link
Member

akarnokd commented Feb 6, 2017

Note that the images inside the javadoc may be skewed. Let me know if you'd like to post a PR that fixes the width= and height= constants for these.

@Stephan202
Copy link
Contributor Author

@akarnokd, thanks for generating these images. As for your fixing the dimensions, I filed PR #5087 for that; let me know whether that's what you intended.

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

No branches or pull requests

2 participants