Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Uneven documentation of parameters #161

Open
EmilHvitfeldt opened this issue Apr 20, 2021 · 0 comments
Open

Uneven documentation of parameters #161

EmilHvitfeldt opened this issue Apr 20, 2021 · 0 comments

Comments

@EmilHvitfeldt
Copy link
Member

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants