rethinkdb / rethinkdb/docs

API: add time complexity to commands

Open
#50 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

api
Dominant language
CSS
Stars
118
Forks
161
PR merge metrics
No merged PRs in 30d

Description

@kevincox said this in the original issue (rethinkdb/rethinkdb#620):

When selecting and designing with a database it is important to know the cost of
what queries in what situations. For example, it is often reasonable to use a
quadratic query, if you know the size of your dataset will be under a certain size.

It would be very useful to have the expected time complexities of the queries in the
documentation and the cases for which the complexity will be different. This is
something that Redis does really well for example.

This was met with complete agreement by everyone involved.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No files, tests, or specific commands are named. Begin by locating the command-reference documentation and identifying the commands and cases whose expected time complexities can be established; done means the relevant documentation records those complexities and exceptions.

Written by the indexing model from the issue text.

Assessment

Domain
databases, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.