Document R6 class using new roxygen feature
cderv opened this issue · comments
This is now possible to document R6 method using roxygen.
https://roxygen2.r-lib.org/articles/rd.html#r6
We have already documented but it could be an improvement and easier to maintain.
I hope the help page is organized clearer also.
Just putting this here as an idea for when we have time.
I haven't seen that. Excellent!
There an issue to fix here
==> devtools::document(roclets = c('rd', 'collate', 'namespace'))
Updating crrri documentation
Loading crrri
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")`.
Calls: suppressPackageStartupMessages ... extract_r6_self_data -> rbind -> extract_r6_methods -> map_int -> .f
Ex�cution arr�t�e
Exited with status 1.
Should look into it.
It seems we have a special case somewhere not handled by roxygen2 R6 support
See r-lib/roxygen2#1014
We will deactivate it for now
And we have the issue above only with the default load method in roxygenise
# does not work
roxygen2::roxygenise(load_code = "pkgload")
# works
roxygen2::roxygenise(load_code = "source")
We could use Roxygen: list(load = "source")
in DESCRIPTION to change the default. But I am still puzzled why the default does not work...
Note to self: Roxygen: list(load = "source")
is taken into account by devtools::document()
in console but not by CTRL + SHIFT + D or Document in IDE Build pane
Seems to be a bug... must find a minimal reproducible example. We can reproduce using this package state but it is an heavy example