Wording of r.literal api page
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
updateandmergeterms that a field in an object should be replaced entirely by the value passed tor.literal, rather than being merged with it. Ifr.literalis not passed an argument,updateandmergewill remove the field from the resulting document.
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
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