Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(create): add more details about static create function #2390

Merged
merged 1 commit into from
Feb 21, 2017
Merged

docs(create): add more details about static create function #2390

merged 1 commit into from
Feb 21, 2017

Conversation

mpodlasin
Copy link
Contributor

@mpodlasin mpodlasin commented Feb 19, 2017

Description:

  • Flesh out what is an Observable Contract.
  • Add note about returning TeardownLogic in passed function.
  • Change subscribe to onSubscription so that there is no confusion when function is called.
  • Switch Subscriber instance as a function argument to Observer interface, so that users are not encouraged to use Subscribers implementation details.
  • Add note about TS signature issue.
  • Add examples with calling observers error and returning teardown logic.
  • Do not mark function passed to create as optional, since subscribing to Observable created in such way will throw an Error.

Flesh out what is an Observable Contract. Add note about
returning TeardownLogic in passed function. Change 'subscribe'
to 'onSubscription' so that there is no confusion when function
is called. Switch Subscriber instance as a function argument to
Observer interface, so that users are not encouraged to use
Subscribers implementation details. Add note about TS signature
issue. Add examples with calling observers error and returning
teardown logic. Do not mark function passed to create as optional,
since subscribing to Observable created in such way will throw
an Error.
@coveralls
Copy link

coveralls commented Feb 19, 2017

Coverage Status

Coverage remained the same at 97.688% when pulling cc3824d on Podlas29:create-docs into b9f611a on ReactiveX:master.

@benlesh benlesh merged commit c806cc6 into ReactiveX:master Feb 21, 2017
@lock
Copy link

lock bot commented Jun 6, 2018

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.

@lock lock bot locked as resolved and limited conversation to collaborators Jun 6, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants