docs(from): Convert docs for from #4031
Conversation
src/internal/observable/from.ts
Outdated
| @@ -34,3 +34,74 @@ export function from<T>(input: ObservableInput<T>, scheduler?: SchedulerLike): O | |||
|
|
|||
| throw new TypeError((input !== null && typeof input || input) + ' is not observable'); | |||
| } | |||
|
|
|||
| /** | |||
There was a problem hiding this comment.
Hi Rob, basically this is an awesome pr. Thanks for all the work you put into it. But this part has to be above the function declaration to be valid JSDoc. Maybe take a look at another operator like fromEvent then you will see what I mean.
src/internal/observable/from.ts
Outdated
| * // Logs: | ||
| * // 10 20 30 | ||
| * ``` | ||
| * <a href="https://stackblitz.com/edit/js-tfvhag" target+"_blank">Stackblitz example</a> |
There was a problem hiding this comment.
I really appreciate adding stackblitz, but first I think it doesn't really adds value for the small api examples. I think it would be more helpful for the tutorial, we want to add soon. Additionally this messes up the outline in the docs and it isn't conform with accessibility standards. Really thanks for this, but I think this makes sense to add in a seperate pull request
There was a problem hiding this comment.
sounds great to me. I will remove these examples and use later in tutorials.
src/internal/observable/from.ts
Outdated
| * ``` | ||
| * | ||
| * <a href="https://stackblitz.com/edit/js-kghdtb" target="_blank">StackBlitz example</a> | ||
| */ |
There was a problem hiding this comment.
could you add param describtion for the method signature and return value
|
BTW: This will close #4027 |
pertrai1
force-pushed
the
from-docs-update
branch
3 times, most recently
from
6213d4b
to
ae81c6a
Compare
src/internal/observable/from.ts
Outdated
| * @see {@link fromEventPattern} | ||
| * @see {@link fromPromise} | ||
| * | ||
| * @param {ArrayLike<T> | ObservableInput<T>} A subscription object, a Promise, an Observable-like, |
There was a problem hiding this comment.
ObserableInput is a type of SubscribableOrPromise<T> | ArrayLike<T> | Iterable<T> therefore adding ArrayLike<T> isn't really needed
pertrai1
force-pushed
the
from-docs-update
branch
from
ae81c6a
to
c996b0a
Compare
Description:
Update the new docs for
fromwith the older docs and add live StackBlitz example.