Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

cabal check should warn when readme and other dev docs file exist in the working tree, but are not included in extra-doc-files #10802

Open
ffaf1 opened this issue Feb 23, 2025 · 0 comments

Comments

@ffaf1
Copy link
Collaborator

ffaf1 commented Feb 23, 2025

Offspring of #3964.

Describe the feature request
Browsing Hackage or flora.pm would be a much nicer experience if everyone added their devel docs to extra-doc-files.
Sometimes this is not the case, because people forget or because they choose not to (as rendering on Hackage might be off).

It would be nice if cabal check looked for all such files in the working tree and hinted the author to add them.
As now cabal check warns about changelogs but not other files (e.g. READMEs).

The check would have to be granular, so users can --ignore specific warnings.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant