roxytest icon indicating copy to clipboard operation
roxytest copied to clipboard

FALSE positive with return_roclet

Open ColinFay opened this issue 3 years ago • 2 comments

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.

ColinFay avatar Jun 02 '22 13:06 ColinFay

@ColinFay : Thanks for reporting this bug! I will have a look at making a fix at some point, but you are also welcome to submit a PR.

mikldk avatar Jun 02 '22 13:06 mikldk

@ColinFay Can you try 224543a?

mikldk avatar Jun 08 '22 18:06 mikldk