Skip to content

Fix few hlint warnings, fix cabal check warning, improve haddocks#4

Merged
debug-ito merged 1 commit intodebug-ito:hlint-cabal-check-fixesfrom
jhrcek:jan/hlint-cabal-check-fixes
Mar 28, 2025
Merged

Fix few hlint warnings, fix cabal check warning, improve haddocks#4
debug-ito merged 1 commit intodebug-ito:hlint-cabal-check-fixesfrom
jhrcek:jan/hlint-cabal-check-fixes

Conversation

@jhrcek
Copy link
Contributor

@jhrcek jhrcek commented Mar 25, 2025

Thank you for this nice package, it's exactly what I need to solve the issue I have.
Please accept this assortment of small fixes and improvements as a token of my gratitude 😸

category: Control
cabal-version: 2.0
build-type: Simple
extra-source-files: README.md, ChangeLog.md
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Explanation for this change:

$ cabal check
These warnings may cause trouble when distributing the package:
Warning: [doc-place] Please consider moving the file 'ChangeLog.md' from the
'extra-source-files' section of the .cabal file to the section
'extra-doc-files'

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we should put README.md in extra-doc-files, too?

Copy link
Contributor Author

@jhrcek jhrcek Mar 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

At the moment cabal doesn't raise a warning about readme.
Checking the cabal source code I see there's no specific check for readme (it's commented out).
Also most packages on hackage that I checked have readme mentioned as extra-source-file, so it should be fine.

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@debug-ito debug-ito changed the base branch from master to hlint-cabal-check-fixes March 28, 2025 04:12
@debug-ito debug-ito merged commit 4d960e6 into debug-ito:hlint-cabal-check-fixes Mar 28, 2025
11 checks passed
@jhrcek
Copy link
Contributor Author

jhrcek commented Mar 28, 2025

Oops, now I noticed that this PR mistakenly targetted debug-ito:hlint-cabal-check-fixes branch in your repo. Should I open one more PR targetting master?

@debug-ito
Copy link
Owner

Don't worry. It was I who changed the target branch. I just wanted to do some more work before merging to master.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants