docs(combineLatest): add details about static version of operator #2351
Conversation
|
I'm going to try to review this shortly. btw you might take a look at the reactivex docs as they usually contain excellent operator descriptions since it's mostly a sum of all Rx implementations. http://reactivex.io/documentation/operators/combinelatest.html There's no harm in boosting some (or all) of their descriptions. Just note that, while rare, RxJS sometimes has differing semantics of certain operators. |
| * corresponding to order of passed Observables (value from the first Observable | ||
| * on the first place and so on). | ||
| * | ||
| * Static version of `combineLatest` accepts either an array of Observables |
There was a problem hiding this comment.
Shouldn't the static version of combineLatest be documented along side of that code? This file is for the member method.
There was a problem hiding this comment.
Are you sure? This is observable directory, where are all functions that land on Observable. Unless we understand static differently?
There was a problem hiding this comment.
@Blesh this JSDoc is for the static, as you can see down there we have the tag @static true which instructs ESDoc when generating the site.
There was a problem hiding this comment.
@staltz @Podlas29 right you are. 👍
Add more about when combineLatest emits, completes and errors. Add information about different ways it can be called and different paramteres it accepts. Provides examples of different ways operator can be called.
|
This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs. |
Description:
Yet another pr with more detailed documentation for operator.
I struggled to meaningfully describe what scheduler actually does with this operator. This is related to my issue here: #2350.
Irony is that I know how this operator behaves with different schedulers, but I have no idea how to describe it without going into implementation details (calling out
ArrayObservableimplementation and the fact thatcombineLatestsubscribes to input Observables in itscompletefunction). I would really appreciate some help or pointers here.Other doc prs
#2322 - here is more background what do I do and why
#2326