yesodweb / yesodweb/persistent
hidden documentation for PersistField
Nobody has claimed this yet.
- Dominant language
- Haskell
- Stars
- 486
- Forks
- 306
- PR merge metrics
- No merged PRs in 30d
Description
Look at the haddock for PersistField http://hackage.haskell.org/package/persistent-2.10.0/docs/Database-Persist-Class.html#g:6
I see an Examples section and then a long Instances list and no other documentation.
However, if I click on the + Examples, hiding the Examples, new hidden documentation appears with a new heading of "Simple Newtype" "Smart Constructor Newtype" etc.
This is probably a haddock bug underneath, but it's making persistent's docs much harder to understand, so I thought I'd file it here.
(Seeing the problem in both firefox and chromium.)
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 PersistField Haddock page linked in the issue and reproduce the behavior by expanding and collapsing Examples in Firefox or Chromium. Compare the visible sections before and after toggling; done means the documentation no longer reveals unrelated headings and text when Examples is collapsed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- haskell
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100