[Docs] Error in "Contramapping Commands" example code
Open
Nobody has claimed this yet.
- Dominant language
- Scala
- Stars
- 1.7k
- Forks
- 175
- Avg merge
- 5d 14h
- Merged PRs (30d)
- 9
Description
In https://github.com/tpolecat/skunk/blob/v0.2.0/modules/docs/src/main/paradox/tutorial/Command.md#contramapping-commands, the sequence of the values code and hos is wrong, and they get mapped to the opposite database field. It's hard to notice, because they are both strings.
The same also happens in the next example using .gcontramap[Info].
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
Open modules/docs/src/main/paradox/tutorial/Command.md at the “Contramapping Commands” section and compare the code and hos value order with their database fields. Check the following .gcontramap[Info] example as well; done means both examples map code and hos to the intended fields.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- postgres, scala
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 50/100