Some of our pages could be made more clear by showing the data model the operation is working on and the result of the query
Open
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 118
- Forks
- 161
- PR merge metrics
- No merged PRs in 30d
Description
For instance .changeAt() - http://rethinkdb.com/api/javascript/change_at/
I think it should something like this down below the ReQL query just to be completely explicit and clear. A lot of other pages could benefit from this.
["Iron Man", "Hulk", "Spider-Man"]
List forthcoming, but wanted to put this down.
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
Start with the JavaScript .changeAt() API page and its ReQL query example. Review similar documentation pages to identify where the operation's data model and query result should be shown. Done means the relevant pages clearly include both pieces of information, including an output example like the proposed list.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100