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

reactivex.io documentation needs to reference v5+ #2369

Open
jayphelps opened this issue Feb 13, 2017 · 7 comments
Open

reactivex.io documentation needs to reference v5+ #2369

jayphelps opened this issue Feb 13, 2017 · 7 comments
Assignees
Labels
docs Issues and PRs related to documentation

Comments

@jayphelps
Copy link
Member

jayphelps commented Feb 13, 2017

The docs on reactivex.io e.g. http://reactivex.io/documentation/operators/repeat.html still reference the v4 implementation API.

I'm not immediately sure how these docs are generated and more importantly, kept in sync with our real docs. I imagine @mattpodwysocki knows, so hopefully he can help lead the way.

If it's currently just manual process of updating their repo, I'm initially inclined to just remove them and/or link to our docs instead. It's not ideal, but I think it's better than having to continuously be told our docs on reactivex.io are out of date or not as good as our real docs (if they ever are actually good...)

@Karasuni
Copy link

Karasuni commented Apr 7, 2017

This issue is still present. How can we act on this and update the documentation?

@Karasuni
Copy link

List of differences between reactivex.io documentation and the actual implementation:

  • .doOnNext(), .doOnError(), .doOnCompleted
  • .tapOnNext(), .tapOnError(), .tapOnCompleted
  • .delaySubscription(), .delayWithSelector()
  • Observer .onNext(), .onError(), .onCompleted()
  • Observable .createWithDisposable(), .generate() .generateWithAbsoluteTime() .generateWithRelativeTime()

There are more but it will take some time to compile.

Does anyone know how we can remove these outdated entries from the documentation to avoid countless confusion and time wasted?

@Karasuni
Copy link

May 2017 - Any update?

@jayphelps
Copy link
Member Author

@Karasuni I don't think providing the date is productive.

@Karasuni
Copy link

But how can we resolve this issue?

@benlesh
Copy link
Member

benlesh commented Aug 18, 2020

Hey, @niklas-wortmann, do you think you can have a look at the reactivex.io site? The git repo for it is here: https://github.com/ReactiveX/reactivex.github.io

I can get you access, and put you in contact with the maintainers. I think we just need to get all of the RxJS stuff there to point to our documentation site.

@benlesh benlesh added the AGENDA ITEM Flagged for discussion at core team meetings label Aug 18, 2020
@niklas-wortmann
Copy link
Member

niklas-wortmann commented Aug 18, 2020

I will have a look and see what we can do about that! Thanks for mentioning me. I was absolutely not aware of this

@benlesh benlesh removed the AGENDA ITEM Flagged for discussion at core team meetings label Feb 10, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Issues and PRs related to documentation
Projects
None yet
Development

No branches or pull requests

5 participants