yesodweb / yesodweb/persistent
Clarify the order stability of insertMany
Open
Nobody has claimed this yet.
- Dominant language
- Haskell
- Stars
- 486
- Forks
- 306
- PR merge metrics
- No merged PRs in 30d
Description
insertMany :: ... => [record] -> ReaderT backend m [Key record]
Are the keys necessarily returned in an order corresponding to the record list parameter, or might the ordering be nondeterministic? Either way, I think it deserves a note in the haddocks.
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 insertMany entry point and its existing Haddock signature. Compare the behavior across the persistence backends to determine whether returned keys follow the input record order or may be nondeterministic. Done means the ordering guarantee, or lack of one, is stated clearly in the Haddock.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- haskell
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100