Identify internal function according to tidyverse style guide

[judith-bourque]

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."

#' Drop last
#'
#' Drops the last element from a vector.
#'
#' @param x A vector object to be trimmed.
#'
#' @noRd

[judith-bourque]

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

[judith-bourque]

Could removing the @export tag from internal functions allow @noRd to pass R CMD check?

[judith-bourque]

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.

[judith-bourque]

Task for each function

• [x] Remove @export
• [x] Add @noRd

Internal functions

• [x] error_if_parameter_null()
• [x] create_metrics_req()
• [x] create_pageviews_req()
• [x] create_req()
• [x] add_user_agent()

Commit message: Add no Rd, remove export for