Iss028: Add @return and @example to every function with @export #32
Conversation
jhseeman
left a comment
jhseeman
left a comment
There was a problem hiding this comment.
thanks for doing this! One general style comment: there are places throughout where we have local objects clashing with global package names (ex: roadmap <- roadmap()). I think the examples will be clearer if we avoid this behavior.
NAMESPACE
Outdated
| S3method(print,visit_sequence) | ||
| export("%>%") | ||
| export(.calc_bandwidths) | ||
| export(.construct_workflows) |
There was a problem hiding this comment.
we can probably remove this export
| #' | ||
| #' @examples | ||
| #' | ||
| #' noise() |
There was a problem hiding this comment.
should be pretty easy to add self-contained examples here, yes?
| #' | ||
| #' @examples | ||
| #' | ||
| #' start_method(start_func = start_resample) |
There was a problem hiding this comment.
we should add some example arguments to be passed to start_resample
There was a problem hiding this comment.
I add a couple of examples!
R/invert.R
Outdated
| #' @param predictions A data frame with .pred | ||
| #' @param ... Other arguments | ||
| #' | ||
| #' @return A tibble with inverted model-generated values |
There was a problem hiding this comment.
are we intending two different @return statements here?
There was a problem hiding this comment.
Good catch. Updated!
| command. | ||
| # Or the development version from GitHub: | ||
| # install.packages("pak") | ||
| pak::pak("UrbanInstitute/tidysynthesis") |
There was a problem hiding this comment.
is there a reason we're switching from install_github to pak?
There was a problem hiding this comment.
I'm emulating tidymodels, which now uses pak: https://github.com/tidymodels/tidymodels
|
I responded to your feedback. I switched |
@exportfrom a few functions