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

Some things need fixing in the "DAO User Guide" #524

mdittmer opened this issue Jan 8, 2016 · 0 comments


Copy link

commented Jan 8, 2016

Explication of the Sink interface reads "remove()"; should be "remove(obj)".

Long-form description of "put(obj, sink)" does not discuss the error case.

"NB" in long-form description of "remove(objOrId, sink)" should clarify whether or not the "remove(obj)" callback is called when no such object exists in the DAO. It should also mention what the value of "obj" will be in this case.

In long-form description of "select(sink, options)", we say that the Future is resolved "at the same time as sink.eof() is called". This statement is ambiguous in a single-threaded Javascript world. We need to document which one is actually called first (or else mention that either order is acceptable).

Long-form description of "removeAll(sink, options)" should briefly describe which callbacks are called when. Is it a sequence of "remove(obj)"s, potentially halted early by a call to "error(error)"?

In long-form description of "listen(sink, options)" we use the example "myDAO.where(...).listen()", then refer to the "query". Perhaps the example code should contain "where(query)".

Does "pipe(sink, options)" issue an "eof()" after the select-part, before the listen-part?

Suggest removing "infinite" from "infinite scrolling".

@mdittmer mdittmer added the docs label Jan 8, 2016

@mdittmer mdittmer added this to the cleanup milestone Jan 8, 2016

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
None yet
2 participants
You can’t perform that action at this time.