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.

Sign up for GitHub

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

Jump to bottom

Fix documentation on Hackage #7

Open
NicolasT opened this issue Aug 18, 2022 · 2 comments
Open

Fix documentation on Hackage #7

NicolasT opened this issue Aug 18, 2022 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@NicolasT
Copy link
Owner

For some reason, the API documentation as hosted on Hackage doesn't include all docs. As an example, the constructors of AccessFsFlag don't have their associated docstrings. However, a local render of the docs (either as-is, or using --haddock-for-hackage, then unpacking the resulting tarball and opening the HTML pages) included the desired information.
@NicolasT NicolasT added the documentation Improvements or additions to documentation label Aug 18, 2022
@NicolasT
Copy link
Owner Author

Cfr. https://discourse.haskell.org/t/troubleshooting-hackage-doc-build-failures/5888

@NicolasT
Copy link
Owner Author

NicolasT commented Mar 1, 2023

This may be due to an issue in Cabal, reported at haskell/cabal#8824

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@NicolasT