Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

FALSE positive with return_roclet #24

Open
ColinFay opened this issue Jun 2, 2022 · 2 comments
Open

FALSE positive with return_roclet #24

ColinFay opened this issue Jun 2, 2022 · 2 comments

Comments

@ColinFay
Copy link
Contributor

ColinFay commented Jun 2, 2022

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.

@mikldk
Copy link
Owner

mikldk commented Jun 2, 2022

@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 added a commit that referenced this issue Jun 8, 2022

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
@mikldk
Copy link
Owner

mikldk commented Jun 8, 2022

@ColinFay Can you try 224543a?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants