yesodweb / yesodweb/persistent
Documentation for `nest*` is wrong
Open
Nobody has claimed this yet.
mongoDB
- Dominant language
- Haskell
- Stars
- 486
- Forks
- 306
- PR merge metrics
- No merged PRs in 30d
Description
The haddocks for nest* are all talking about equality where as the names clearly indicate they should be talking about inequality comparisons of various sorts (LE, GE, Ne). I'd fix but am not clear on the intent of In and NotIn seeing as those are still only taking a typ and not [typ] like I'd expect.
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 by locating the Haddock comments for the nest* functions and compare their descriptions with the named LE, GE, and Ne comparisons. Resolve the intended meaning of In and NotIn before updating the documentation, and confirm that each description matches the corresponding operator.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- haskell
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100