tidymodels / tidymodels/rsample
`slide-resampling.Rd` is missing a \value section
Nobody has claimed this yet.
- Dominant language
- R
- Stars
- 343
- Forks
- 67
- Avg merge
- 1h 9m
- Merged PRs (30d)
- 2
Description
The man page for sliding_window(), sliding_index(), and sliding_period() (man/slide-resampling.Rd, generated from the @name slide-resampling roxygen block in R/slide.R) documents parameters in detail but has no \value section describing what the functions return. None of the three #' @rdname slide-resampling function definitions in R/slide.R include an @return roxygen tag.
Suggested fix: add an @return tag to the shared documentation block, e.g.:
#' @return An `rset` object with a `splits` column of `rsplit` objects and,
#' depending on the function, an `id` column for the resample identifier.
Then run devtools::document() to regenerate man/slide-resampling.Rd.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Update the shared documentation block in R/slide.R for the three functions, then run devtools::document() to regenerate man/slide-resampling.Rd. Start by reviewing the existing roxygen block and confirm the generated man page includes a value section describing the returned rset object and its columns.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- r
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Active
- Clarity
- Clearly specified
- Newbie friendliness
- 92/100