docs(subscribe): create the documentation #2454
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
staltz
reviewed
Mar 11, 2017
src/Observable.ts
Outdated
| subscribe(): Subscription; | ||
| subscribe(observer: PartialObserver<T>): Subscription; | ||
| subscribe(next?: (value: T) => void, error?: (error: any) => void, complete?: () => void): Subscription; | ||
| /** | ||
| * Puts an Observable to work and registers handlers for events it will emit. |
There was a problem hiding this comment.
I would describe this as "Invoke an execution of this Observable and register Observer handlers for notifications it will emit." because this is the style of language we use also in the Manual. ("invoke", "execution", etc)
The informal description is okay.
Document subscribe method, focusing on what it accepts and returns, how it differs from regular operators and whether it calls its callbacks synchronously or asynchronously. Closes #2449
|
@staltz done |
|
PR is all green to merge |
|
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. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Document subscribe method, focusing on what it accepts and returns, how it differs from regular operators and whether it calls its callbacks synchronously or asynchronously.
Closes #2449