-
Notifications
You must be signed in to change notification settings - Fork 92
Move all models' update
docs
#479
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
Conversation
R/update.R
Outdated
#' parameters to update. If the individual arguments are used, | ||
#' these will supersede the values in `parameters`. Also, using |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If the individual arguments are used, these will supersede the values in
parameters
.
I'm not entirely sure what this means. Could you expand on what "individual arguments" refers to?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do you think this is more clear?
A 1-row tibble or named list with main parameters to update. Use either
parameters
or the main arguments directly when updating. If the main arguments are used, these will supersede the values inparameters
. Also, using engine arguments in this object will result in an error.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah that is very clear yes, thank you!
Co-authored-by: Davis Vaughan <davis@rstudio.com>
This pull request has been automatically locked. If you believe you have found a related problem, please file a new issue (with a reprex: https://reprex.tidyverse.org) and link to this issue. |
Closes #423
This PR moves the documentation for
update
methods from the individual model pages to a centralizedupdate
page. We want to do this before we make any more headway on the big documentation change for models outlined in #456.