haskell-flake icon indicating copy to clipboard operation
haskell-flake copied to clipboard

Option docs `haskellProjects.<name>.packages` is incomplete

Open srid opened this issue 1 year ago • 1 comments

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 https://github.com/srid/haskell-flake/issues/162#issuecomment-1992530078

srid avatar Mar 12 '24 20:03 srid

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.

srid avatar Mar 13 '24 13:03 srid