docs(operators): fix ESDoc build to put operators under Observable class #1376
Conversation
|
Might want to hold off on this until @david-driscoll's type signature changes are merged, then generate the doc from those interfaces. Those interfaces provide specific, well typed overloads for each operator, which means more details in the docs. |
|
rebase: that's ok :) |
staltz
force-pushed
the
esdoc-fix-reference-structure
branch
2 times, most recently
from
05b8024
to
7251390
Compare
This moves operators from being top-level functions (they are not, because they are added/monkey-patched to the Observable type) to being methods under the Observable class.
staltz
force-pushed
the
esdoc-fix-reference-structure
branch
from
7251390
to
ad88f2e
Compare
| * @param {function} [project] an optional function to project the values from the combined recent values into a new value for emission. | ||
| * @returns {Observable} an observable of other projected values from the most recent values from each observable, or an array of each of | ||
| * the most recent values from each observable. | ||
| */ | ||
| /* tslint:disable:max-line-length */ | ||
| export function combineLatestStatic<T>(v1: ObservableInput<T>, scheduler?: Scheduler): Observable<[T]>; |
There was a problem hiding this comment.
How does esdoc shows these overloads? (when n-param definitions are available via operator)
There was a problem hiding this comment.
You can see it for yourself here http://rxjs5-esdoc-fix-reference-structure.surge.sh/class/es6/Observable.js~Observable.html#static-method-combineLatest
There was a problem hiding this comment.
I thought that was not reflecting latest changes (since it shows just one signatures). :)
|
Change looks good to me, I'll check in this around late today if there isn't other suggestions. |
|
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. |
This moves operators from being top-level functions (they are not, because they are
added/monkey-patched to the Observable type) to being methods under the Observable class.
To see this page live, open http://rxjs5-esdoc-fix-reference-structure.surge.sh/