haskell / haskell/cabal

Readme as Description

Open
#10,803 5 comments 0 reactions 0 assignees View on GitHub
cabal-install: cmd/haddock type: enhancement
Dominant language
Haskell
Stars
1.7k
Forks
750
Avg merge
4d 3h
Merged PRs (30d)
28

Description

**Describe the feature request**
I would like to include whole readme or first section into haddock output instead of content
from cabal `description` section if it is missing.

Markdown syntax is isomorphic to haddock one.

**Additional context**
I think readme file and cabal description section share a lot of data and
keeping them in-sync is a boring task.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.