Each public sublibrary should have it's own description field
Open
cabal-install: cmd/haddock
cabal-install: cmd/haddock-project
Cabal: stanza/library
re: internal library
type: enhancement
- Dominant language
- Haskell
- Stars
- 1.7k
- Forks
- 750
- Avg merge
- 4d 3h
- Merged PRs (30d)
- 28
Description
Per sublibrary description should be used by haddock. Right now haddock is using the top level description of the package for every sublibrary.
Contributor guide
Research direction
Start by tracing how Cabal represents package and public sublibrary descriptions and how Haddock consumes them. Confirm where the top-level package description is currently reused, then make each public sublibrary provide its own description; done means Haddock displays the relevant sublibrary description instead of the package description.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- haskell
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100