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

Option docs haskellProjects.<name>.packages is incomplete #272

Open
srid opened this issue Mar 12, 2024 · 1 comment
Open

Option docs haskellProjects.<name>.packages is incomplete #272

srid opened this issue Mar 12, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@srid
Copy link
Owner

srid commented Mar 12, 2024

The option documentation at perSystem.haskellProjects..packages is incomplete, it doesn't tell me what's valid to put there. An example would be very helpful, but sub-options would be even better, if feasible.

I think part of the problem is deferredModule, which only renders documentation if you use deferredModuleWith { staticModules = ...; }, but that's only usable if you have modules should always be imported, which may not actually be the case here.

Originally posted by @roberth in #162 (comment)

@srid srid added the documentation Improvements or additions to documentation label Mar 12, 2024
@srid
Copy link
Owner Author

srid commented Mar 13, 2024

I think part of the problem is deferredModule, which only renders documentation if you use deferredModuleWith { staticModules = ...; }, but that's only usable if you have modules should always be imported, which may not actually be the case here.

Do I understand this correctly: that this is a problem with nixpkgs, and we can't anything about it here in haskell-flake? i.e., all we can do is expand the description of the packages module to include some examples.

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

No branches or pull requests

1 participant