Methods without guaranteed order
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 118
- Forks
- 161
- PR merge metrics
- No merged PRs in 30d
Description
Update the docs to point out which methods don't guarantee the results will be ordered as "expected".
For example, getAll(1, 2, 3) doesn't ensure the results are ordered as [{id: 1}, {id: 2}, {id: 3}].
Another example is do(query1, query2) doesn't ensure that query1 is evaluated first.
There may be others I'm forgetting about.
Edit: Actually, it seems like do(query1, query2) always evaluates query2 first (testing with rethinkdbdash). That should be mentioned in the docs, too.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Search the documentation for the getAll and do method references and review how result-order guarantees are described. Identify other methods with relevant ordering behavior, then document the guarantees and run the documentation checks to confirm the updated pages build successfully.
Written by the indexing model from the issue text.
Assessment
- Domain
- databases, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100