Skip to content

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

Merged
merged 8 commits into from
Apr 27, 2021
Merged

Move all models' update docs #479

merged 8 commits into from
Apr 27, 2021

Conversation

juliasilge
Copy link
Member

Closes #423

This PR moves the documentation for update methods from the individual model pages to a centralized update page. We want to do this before we make any more headway on the big documentation change for models outlined in #456.

@juliasilge juliasilge requested a review from DavisVaughan April 26, 2021 22:33
R/update.R Outdated
Comment on lines 23 to 24
#' parameters to update. If the individual arguments are used,
#' these will supersede the values in `parameters`. Also, using
Copy link
Member

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?

Copy link
Member Author

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 in parameters. Also, using engine arguments in this object will result in an error.

Copy link
Member

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!

juliasilge and others added 2 commits April 27, 2021 11:38
Co-authored-by: Davis Vaughan <davis@rstudio.com>
@juliasilge juliasilge merged commit 639fe1a into master Apr 27, 2021
@juliasilge juliasilge deleted the move-update-docs branch April 27, 2021 19:30
@github-actions
Copy link

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.

@github-actions github-actions bot locked and limited conversation to collaborators May 12, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Removing update.*() from Github Pages
2 participants