Allowed parameter documentation is ... sparse
Nobody has claimed this yet.
- Dominant language
- R
- Stars
- 117
- Forks
- 36
- Avg merge
- 1h 53m
- Merged PRs (30d)
- 2
Description
I had a really hard time figuring out what acceptable values are for parameters. Often times the documentation is unclear with regards to:
- Acceptable type
- Bounds on numerics
Beyond allowed values, some heuristics on what reasonable values are would also be valuable.
Occasionally categorical values aren't listed out either. Consider prune_method in mars, which only refers the user to earth::earth() without cross-linking the documentation.
On the whole, I strongly recommend a major update to the parameter documentation to add additional detail.
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 parameter documentation throughout dials and the documentation for prune_method in mars, including the referenced earth::earth() documentation. Done means documenting acceptable types, numeric bounds, reasonable values, and categorical options, with the relevant cross-link added; the issue does not name specific files or tests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- r
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100