Skip to content

Document R6 class#98

Draft
cderv wants to merge 1 commit into
masterfrom
R6-document
Draft

Document R6 class#98
cderv wants to merge 1 commit into
masterfrom
R6-document

Conversation

@cderv

@cderv cderv commented May 24, 2020

Copy link
Copy Markdown
Collaborator

@cderv

cderv commented May 24, 2020

Copy link
Copy Markdown
Collaborator Author

Currently it does not work as expected on my end.

If I use load = "source" in DESCRIPTION, or roxygen2::roxygenise(load_code = "source") I get warnings about the roxygen tags for method not being associated with the method. a getSrcRef issue...

Warning: [C:\Users\chris\Documents\DEV_R\00-project\crrri\R\EventEmitter.R:88] @description Cannot find matching R6 method
Warning: [C:\Users\chris\Documents\DEV_R\00-project\crrri\R\EventEmitter.R:89] @param Cannot find matching R6 method

If I use the default method, I get the error described in #84

> roxygen2::roxygenise(load_code = "pkgload")
Loading crrri
Writing NAMESPACE
Error in .f(.x[[i]], ...) : 
  R6 class (EventEmitter) without source references. If you use the `installed` load method in `DESCRIPTION`, then try re-installing the package with option '--with-keep.source'. E.g. `install.packages(..., INSTALL_OPTS = "--with-keep.source")`.

Again an issue with source reference.

I can't reproduce the issue with R6 documentation on a dummy package yet. It only happens with crrri... 🤯

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

Successfully merging this pull request may close these issues.

Document R6 class using new roxygen feature

1 participant