liquidvotingio / liquidvotingio/api
Run tests on documentation examples
Open
Nobody has claimed this yet.
- Dominant language
- Elixir
- Stars
- 17
- Forks
- 3
- PR merge metrics
- No merged PRs in 30d
Description
Adding `doctest` to the module tests will help us keep documentation up to date.
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 locating the module tests and the documentation examples referenced by this issue, then check how doctest is configured in the project. Add doctest coverage for the relevant modules and confirm the test suite runs the examples successfully.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- elixir
- Domain
- documentation, testing
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100