Uneven documentation of parameters
Nobody has claimed this yet.
- Dominant language
- R
- Stars
- 117
- Forks
- 36
- Avg merge
- 1h 53m
- Merged PRs (30d)
- 2
Description
There is not a lot of documentation for the parameter functions. This is understandable since there isn't a lot to say many times. However, there are still some discrepancies. Here are some documentations that are handled differently
https://dials.tidymodels.org/reference/Laplace.html
https://dials.tidymodels.org/reference/all_neighbors.html
https://dials.tidymodels.org/reference/c5_parameters.html
I would think that the minimum standard should be
- description
- arguments description
- return value
- examples
As a plus, it would be nice to have details concerning what they do like Laplace()
This parameter is often used to correct for zero-count data in tables or proportions.
But it can also be nice to list some of the places where the parameter is used. Although this might be hard due to dependency issues to make work with linking.
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 comparing the Laplace, all_neighbors, and c5_parameters reference pages linked in the issue, then inspect the corresponding parameter-function documentation. Bring inconsistent entries toward the stated minimum of a description, argument descriptions, return value, and examples; consider adding details or usage context where supported. Done means the relevant parameter documentation follows a consistent standard.
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
- Mostly clear
- Newbie friendliness
- 42/100