Fixes #475 - Documentation edits-decluttering the top of the refs page #519
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…e references page
hfrick
reviewed
Aug 15, 2024
R/initial_split.R
Outdated
| @@ -6,7 +6,9 @@ | |||
| #' `group_initial_split` creates splits of the data based | |||
| #' on some grouping variable, so that all data in a "group" is assigned to | |||
| #' the same split. | |||
| #' `training` and `testing` are used to extract the resulting data. | |||
| #' | |||
| #' @details `training` and `testing` are used to extract the resulting data. | |||
There was a problem hiding this comment.
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!
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. | |||
There was a problem hiding this comment.
This would also look great with a set of () at the end
|
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. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #475 - moved args into details section for first three functions to keep references page doc decluttered