Closed judith-bourque closed 1 year ago
With @noRd
, I get this warning
❯ checking for missing documentation entries ... WARNING
Undocumented code objects:
‘get_metrics’
All user-level objects in a package should have documentation entries.
See chapter ‘Writing R documentation files’ in the ‘Writing R
Extensions’ manual.
0 errors ✔ | 1 warning ✖ | 0 notes ✔
It's present even when I add #' @keywords internal
Could removing the @export
tag from internal functions allow @noRd
to pass R CMD check?
Internal function documentation example:
#' Drop last
#'
#' Drops the last element from a vector.
#'
#' @param x A vector object to be trimmed.
#'
#' @keywords internal
#'
#' @noRd # Prevents an Rd from appearing
To prevent the function from being available to users, remove @export
.
Task for each function
@export
@noRd
Internal functions
error_if_parameter_null()
create_metrics_req()
create_pageviews_req()
create_req()
add_user_agent()
Commit message: Add no Rd, remove export for
According to tidyverse style guide,
"Internal functions should be documented with #' comments as per usual. Use the @noRd tag to prevent .Rd files from being generated."