yesodweb / yesodweb/persistent
Small documentation mistake
Open
Nobody has claimed this yet.
- Dominant language
- Haskell
- Stars
- 486
- Forks
- 306
- PR merge metrics
- No merged PRs in 30d
Description
Near EntityWithPrefix, there's the line:
The symbol is a "type application" and requires the TypeApplications@ language extension.
which in the source file is
-- The @ symbol is a "type application" and requires the @TypeApplications@
-- language extension.
That first @ symbol should be escaped, methinks.
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 the linked Database.Persist.Sql.Class source and locate the comment near EntityWithPrefix. Escape the leading @ symbol in the documentation comment, then verify that the rendered source documentation displays it as a literal symbol.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- haskell
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100