Skip to content

FALSE positive with return_roclet #24

@ColinFay

Description

@ColinFay

I have the following code :

#' Who Am I?
#'
#' @return A tibble with user information 
#'
#' @export
#' @rdname whoami
#' @examples
#' users_list(user = "me")
#' whoami()
#'
users_list <- function(user){
 [...]
}

#' @export
#' @rdname whoami
whoami <- function(){
  users_list(user = "me")
}

Roxygenizing this code throws the following:

Functions with @export but no @return:
  * Function 'whoami()' with title ''

This is a false positive because using @rdname, the doc for whoami will be the same as the one from user_list.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions