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

Allowed parameter documentation is ... sparse #50

Open
alexpghayes opened this issue Apr 10, 2019 · 1 comment
Open

Allowed parameter documentation is ... sparse #50

alexpghayes opened this issue Apr 10, 2019 · 1 comment

Comments

@alexpghayes
Copy link

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.

@topepo topepo transferred this issue from tidymodels/parsnip Apr 10, 2019
@topepo
Copy link
Member

topepo commented Aug 5, 2019

The current dev docs have more details

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