The-Strategy-Unit / The-Strategy-Unit/nhp_inputs
Document functions
Open
Nobody has claimed this yet.
documentation
should
- Dominant language
- R
- Stars
- 2
- Forks
- 1
- Avg merge
- 15h 39m
- Merged PRs (30d)
- 6
Description
Most functions in the app do not have {roxygen2} documentation. Add documentation to those without and update existing function documentation where appropriate.
(Description added by @matt-dray.)
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 by locating the app's R functions and checking which already have roxygen2 documentation. Review the existing documentation for accuracy and add or update entries for the undocumented functions; done means the functions are consistently documented with roxygen2.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- r
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100