foam-framework / foam-framework/foam

Some things need fixing in the "DAO User Guide"

Open
#524 0 comments 0 reactions 1 assignee Claimed by @bshepherdson View on GitHub
docs
Dominant language
JavaScript
Stars
783
Forks
51
PR merge metrics
No merged PRs in 30d

Description

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".

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.