marigold-dev / marigold-dev/deku
Add docstrings list_ext module
- Dominant language
- OCaml
- Stars
- 82
- Forks
- 17
- PR merge metrics
- No merged PRs in 30d
Description
After #172 , we should add docstrings to the list_ext module. I know the functions are pretty self-explanatory, but we need to develop the discipline of good docstrings (like the OCaml manual :smile: )
https://github.com/marigold-dev/deku/pull/172#discussion_r723537786
https://github.com/marigold-dev/deku/pull/172#discussion_r723613631
Contributor guide
No contributing guide indexed for this repository
Research direction
Locate the list_ext module and review the linked pull request discussions for the expected docstring style. Add docstrings for its functions; the work is done when the module's public functions are documented consistently with the project's OCaml documentation conventions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ocaml
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100