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

Supply doc is wrong about done #2161

Closed
Altreus opened this issue Jul 9, 2018 · 0 comments
Closed

Supply doc is wrong about done #2161

Altreus opened this issue Jul 9, 2018 · 0 comments
Labels
bug Error of some kind, from a typo to errors in the examples. docs Documentation issue (primary issue type)

Comments

@Altreus
Copy link
Contributor

Altreus commented Jul 9, 2018

The problem

Supply.tap is documented thus:

The &done callback is called when the done method on the supply is called

Whereas, there is no done method on Supply. It correctly documents a live supply:

For a live supply the done routine will be called on the parent Supplier

It is unclear whether an on-demand supply also has a parent Supplier with a done method.

It is also unclear how to stop an on-demand supply.

@JJ JJ added bug Error of some kind, from a typo to errors in the examples. docs Documentation issue (primary issue type) labels Jul 9, 2018
@MorayJ MorayJ mentioned this issue Oct 18, 2018
@MorayJ MorayJ closed this as completed Oct 18, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Error of some kind, from a typo to errors in the examples. docs Documentation issue (primary issue type)
Projects
None yet
Development

No branches or pull requests

3 participants