rxjs: Documentation missing for operator / interface need to be updated
RxJS version:
Code to reproduce:
Expected behavior:
Actual behavior:
Additional information: This is umbrella issue to track documentation status. It is known there are missing documentations around operators, interfaces and website(reactivex.io) need to be updated.
Subject.create
https://github.com/ReactiveX/rxjs/issues/2655
Observable.if
https://github.com/ReactiveX/rxjs/issues/2648
Timeinterval
https://github.com/ReactiveX/rxjs/issues/2627
installation guide on http://reactivex.io/rxjs
https://github.com/ReactiveX/rxjs/issues/2482
finally
https://github.com/ReactiveX/rxjs/issues/2256
https://github.com/ReactiveX/rxjs/issues/2656
About this issue
- Original URL
- State: closed
- Created 7 years ago
- Comments: 28 (12 by maintainers)
I will supplement it:
As everyone says, please update the site docs! It should be priority No1, cause it’s extremely frustrating, for both old and new users, to find outdated or missing information! Please please please, no new features, just docs!
@rinfan speaking with the team about the best way to handle this - also @takamori thank you! 😃
@ladyleet Opened https://github.com/ReactiveX/rxjs-docs/issues/164 (out of date docs, as noted by @rinfan ) and https://github.com/ReactiveX/rxjs-docs/issues/165 (Subject missing any docs) for the specific issues I came here for.
Please update the website docs. It’s very confusing for newcomers not to find the API-docs for e.g. “Observable.subscribe()”
As the docs are added to the actual sources (5 months ago in the case of “subscribe” - see https://github.com/ReactiveX/rxjs/issues/2449#issuecomment-285445755), the generation of the website docs shouldn’t be too much effort.
ajax
/get/post/put/etc
Since @kwonoj closed my issue I’d figured I’d add to the list. I’m willing to write up a draft PR on these if I can get some help with confirming the API to the operators and such. 👍
@anodynos no actual timeline yet!
@ladyleet Is there an issue for updating the website’s documentation? Looks like forkJoin for example is still missing even though the documentation comment was updated months ago. http://reactivex.io/rxjs/class/es6/Observable.js~Observable.html#static-method-forkJoin https://github.com/ReactiveX/rxjs/commit/5cdef625ed7ed312399aec4c2a2ebe62fb0a210b
@benlesh I don’t see why not - @mnquintana @takamori @karptonite @dahei @rinfan @benjamenweber @mpodlasin @wldcordeiro @SangKa this is a super old issue - but if any are still outstanding please create issues on the new rxjs docs initiative. https://github.com/ReactiveX/rxjs-docs/issues // @kwonoj
@JSchneidler it’s already there https://github.com/ReactiveX/rxjs/pull/2400/commits/5cdef625ed7ed312399aec4c2a2ebe62fb0a210b there just hasnt been any updates to the website to use newly generated docs in who knows how long.
It doesn’t look like there is an issue to update the website. It would be nice if at least some of the merged documentation updates made it there. Ended up finding this from #2400 and #2449