`r.getNearest` `maxDist` relation to `unit`
Open
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 118
- Forks
- 161
- PR merge metrics
- No merged PRs in 30d
Description
The following comment was made on IRC, I can see the relation between unit and maxDist being unclear from the current wording.
10:39 < tuanho> Hey guys, documentation on this page is not super clear regarding maxDist. https://rethinkdb.com/api/javascript/get_nearest/
10:39 < tuanho> It's easy to assume that the default unit is kilometers, when it actually it's in meters.
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 get_nearest documentation page linked in the issue. Clarify how maxDist relates to unit, including that the default unit is meters, and verify that the revised wording removes the ambiguity described in the report.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100