yesodweb / yesodweb/persistent
Support single pipe comment style
Open
Nobody has claimed this yet.
- Dominant language
- Haskell
- Stars
- 486
- Forks
- 306
- PR merge metrics
- No merged PRs in 30d
Description
In persistent's QuasiQuoter, you can add documentation using a -- | style doc-comment. Like in purescript, the | must be present on every comment.
-- | This is a table.
-- | This is another line of the doc comment.
SomeTable
-- | This is a field.
-- | This is another line of the field comment.
someField Text
However, this requirement is odd to Haskellers, so we should support having only a single pipe.
-- | This is a table.
-- This is another line of the doc comment.
SomeTable
-- | This is a field.
-- This is another line of the field comment
someField Text
This issue is done when the two code blocks create equal commentary on the produced EntityDefs.
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 persistent's QuasiQuoter implementation and the parser or tests that cover documentation comments and produced EntityDefs. Compare the two comment styles in the issue, then verify that each pair creates equal commentary on the resulting EntityDefs.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- haskell
- Domain
- databases
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 48/100