rethinkdb / rethinkdb/docs

Wording of r.literal api page

Open
#956 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Currently, the r.literal introduction is something like:

Replace an object in a field instead of merging it with an existing object in a merge or update operation. Using literal with no arguments in a merge or update operation will remove the corresponding field.

I think this is a bit confusing because it starts out by explaining what r.literal does, which is very complicated. I think a re-formulation indicating it acts more like a marker than like a function would be nice. Here's a stab at it:

A marker term that indicates to the update and merge terms that a field in an object should be replaced entirely by the value passed to r.literal, rather than being merged with it. If r.literal is not passed an argument, update and merge will remove the field from the resulting document.

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

Open the r.literal API page and compare its current introduction with the wording proposed in the issue. Update the introduction so it explains the marker behavior with update and merge, including the no-argument case, then verify the rendered page reads clearly.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.