-
Notifications
You must be signed in to change notification settings - Fork 724
Open
Labels
Description
Problem
When generating Haddock documentation, autogenerated Paths_* modules trigger warnings about missing documentation for functions like:
versiongetBinDirgetLibDirgetDynLibDirgetDataDirgetLibexecDirgetDataFileNamegetSysconfDir
These modules are fully autogenerated by Cabal, and users typically do not need to document them manually. I think a way to ignore modules while still generating Haddock for the said component woul be very nice.
Proposal
Cabal/Haddock should automatically ignore missing documentation warnings for Paths_* modules, reducing noise in build logs. Or new a setting that could ignore modules.
Benefits
- Cleaner Haddock documentation output.
- Users won’t be bothered by warnings for modules they cannot or do not need to document.
Example
When building documentation for jbeam-edit, Haddock reports missing documentation for all functions in Paths_jbeam_edit. Automatically ignoring this module would remove unnecessary warnings.