`filter` example for nexted documents and pathspec explanation
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 118
- Forks
- 161
- PR merge metrics
- No merged PRs in 30d
Description
We have some examples for filtering by nested attributes using the pathspec format in http://rethinkdb.com/api/javascript/filter/ .
I think it would be good to also have an example and an explanation of how the pathspec syntax works in https://rethinkdb.com/docs/nested-fields/javascript/ .
Currently, that document doesn't explain how to use filter on nested fields at all. Pathspecs also work for some other commands, such as pluck I believe. So it would be nice to explain the general concept with a few examples in the nested-fields document.
See https://github.com/rethinkdb/rethinkdb/issues/5793 and https://github.com/rethinkdb/rethinkdb/issues/5796 for the whole story of how this issue came along.
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 nested-fields JavaScript document at https://rethinkdb.com/docs/nested-fields/javascript/ and compare its existing examples with the filter example at http://rethinkdb.com/api/javascript/filter/. Explain the pathspec syntax and add examples showing how it works with filter and, where appropriate, pluck. Review issues 5793 and 5796 for the surrounding context; done means the nested-fields document clearly covers the general concept.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100