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

The definition of multiple @field field_1,field_2 in R6 object shows a warning. #1600

Open
galachad opened this issue Mar 20, 2024 · 0 comments

Comments

@galachad
Copy link

galachad commented Mar 20, 2024

I define @field as @field field_1,field_2 Field docs. The documentation is generated correctly, but the roxygen show a warning .

image

Minimal R6 class example:

#' Example R6 class
example_object <- R6::R6Class(
  "ExampleObject",
  public = list(
    #' @description Initialize function
    initialize = function() {

    }
  ),
  private = list(),
  active = list(
    #' @field var_1,var_2 do something vars
    var_1 = function(value) {
      message("do somethink var_1")
    },
    var_2 = function(value) {
      message("do somethink var_2")
    }
  )
)

roxygen shows a warning when generating docs:

Warning: [example.R:116] Undocumented R6 active bindings:

Link to the code:

warn_roxy_block(block, "Undocumented R6 active binding{?s}: {miss}")

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

1 participant