rocq-prover / rocq-prover/stdlib
Improving the documentation of MSets
Nobody has claimed this yet.
- Dominant language
- Rocq Prover
- Stars
- 42
- Forks
- 38
- Avg merge
- 14h 6m
- Merged PRs (30d)
- 3
Description
Version
8.7.2
Operating system
Debian
Description of the problem
I was having trouble using the MSets interface https://gist.github.com/jad-hamza/bdcb206dcede2a12945afdbb0e40d012. @ejgallego told me on gitter that it should have been: Module StringDT <: DecidableType., and suggested to open an issue in order to improve the MSets documentation.
Note: it was my first time using Modules.
Contributor guide
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 by reviewing the existing MSets documentation and the linked usage example to understand the reported Module StringDT <: DecidableType interface. Clarify which documentation should be updated and ensure it explains this first-time Modules use case and the expected module declaration.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100