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

Warning when no Haddock documentation installed could be rephrased, for accuracy #9694

Open
mpilgrem opened this issue Feb 4, 2024 · 0 comments

Comments

@mpilgrem
Copy link
Collaborator

mpilgrem commented Feb 4, 2024

Distribution.Simple.Haddock.haddockPackagePaths currently has (extract):

      warning =
        "The documentation for the following packages are not "
          ++ "installed. No links will be generated to these packages: "
          ++ intercalate ", " (map prettyShow missing)

The use of the The in The documentation implies that documentation exists but is not installed. In fact, the message is also generated when a package has no Haddock documentation for legitimate reasons (for example see the mtl-compat package, which can expose no modules for legitimate reasons).

I suggest this message should be re-phrased, as follows:

      warning =
        "The following packages have no Haddock documentation "
          ++ "installed. No links will be generated to these packages: "
          ++ intercalate ", " (map prettyShow missing)

I will raise a pull request, accordingly.

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