pcapriotti / pcapriotti/optparse-applicative
Create a harder split between internal and public modules
Nobody has claimed this yet.
- Dominant language
- Haskell
- Stars
- 959
- Forks
- 123
- Avg merge
- 3d 19h
- Merged PRs (30d)
- 1
Description
We're currently doing an explicit export list from Options.Applicative and Options.Applicative.Arrows which is really the complete public API.
Perhaps everything else should be scoped into an Internal hierarchy with haddock not home annotations on them.
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 explicit export lists in the Options.Applicative and Options.Applicative.Arrows modules, then inventory the remaining modules to understand the current public surface. The work is complete when the intended public API remains explicit and the other modules are consistently scoped under an Internal hierarchy with the requested Haddock annotations.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- haskell
- Domain
- tooling
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100