Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

roxygen-return

Flag an @exported function documented without @return.

CRAN requires every exported function’s documentation to describe its return value (the .Rd \value section); roxygen2 itself stays silent, so the omission otherwise surfaces only at submission time. @returns is accepted as an alias. @noRd blocks and merged or inherited topics (@rdname, @inherit, …) are skipped.

An exported function with no @return:

#' Add one
#' @param x A number.
#' @export
add_one <- function(x) x + 1
warning: roxygen-return
 --> example.R:3:4
  |
3 | #' @export
  |    ^^^^^^^ exported function is documented without `@return`
  = help: Add `@return` (or `@returns`) describing the value.