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

documentation for eval_f is not complete #2

Open
arilamstein opened this issue May 27, 2021 · 0 comments
Open

documentation for eval_f is not complete #2

arilamstein opened this issue May 27, 2021 · 0 comments

Comments

@arilamstein
Copy link

When I run R CMD check I get these issues:

── R CMD check results ──────────────────────────────── funtools 2021.05.27 ────
Duration: 22.4s

checking Rd \usage sections ... WARNING
Undocumented arguments in documentation object 'eval_f'
‘x’ ‘...’

Functions with \usage entries need to have the appropriate \alias
entries, and all their arguments documented.
The \usage entries must correspond to syntactically valid R code.
See chapter ‘Writing R documentation files’ in the ‘Writing R
Extensions’ manual.

checking Rd contents ... WARNING
Argument items with no description in Rd object 'eval_f':
‘env’

checking Rd files ... NOTE
prepare_Rd: eval_f.Rd:12-14: Dropping empty section \value

The actual code for eval_f can be found here. I reproduce it below:

#' eval_f
#'
#' @param x
#' @param ...
#' @param env
#'
#' @importFrom rlang as_quosure eval_tidy
#'
#' @return
#' @export
eval_f <- function (x, ..., env = NULL) {
  quosured <- rlang::as_quosure(x, env = env)
  rlang::eval_tidy(quosured, ...)
}

In short, the parameters are named but not described in the documentation.

I don't have enough experience with rlang to properly describe these variables. But it would be nice if someone updated the documentation so the options are described.

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

No branches or pull requests

1 participant