Option docs `haskellProjects.<name>.packages` is incomplete
Nobody has claimed this yet.
- Dominant language
- Nix
- Stars
- 240
- Forks
- 27
- PR merge metrics
- No merged PRs in 30d
Description
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 usedeferredModuleWith { 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
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the perSystem.haskellProjects..packages option documentation and inspect the deferredModule and deferredModuleWith behavior described in the issue. Done means the documentation explains valid package values, with an example or sub-options if feasible, and accurately reflects how the option is rendered.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- haskell
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100