Skip to content

Fixes #475 - Documentation edits-decluttering the top of the refs page#519

Merged
hfrick merged 3 commits into
tidymodels:mainfrom
laurabrianna:declutter-reference-page
Sep 4, 2024
Merged

Fixes #475 - Documentation edits-decluttering the top of the refs page#519
hfrick merged 3 commits into
tidymodels:mainfrom
laurabrianna:declutter-reference-page

Conversation

@laurabrianna
Copy link
Copy Markdown
Contributor

Fixes #475 - moved args into details section for first three functions to keep references page doc decluttered

Copy link
Copy Markdown
Member

@hfrick hfrick left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks so much for the contribution! As we just chatted, I'll turn the clutter on the reference page into a pkgdown issue but there are some small but nice styling changes possible here anyway, are you up for fixing those?

Comment thread R/initial_split.R Outdated
#' the same split.
#' `training` and `testing` are used to extract the resulting data.
#'
#' @details `training` and `testing` are used to extract the resulting data.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's fine to keep those where they were so not moving them to @details but it would be lovely if they gained a () at the end, so e.g. training() instead of training - then they are easier to identify as functions!

Comment thread R/validation_set.R Outdated
@@ -1,5 +1,7 @@
#' Create a Validation Split for Tuning
#'
#' `validation_set` creates a the validation split for model tuning.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This would also look great with a set of () at the end

@hfrick hfrick merged commit 2c0def3 into tidymodels:main Sep 4, 2024
@github-actions
Copy link
Copy Markdown
Contributor

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 Sep 19, 2024
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.

Declutter start of reference page

2 participants