search

r-lib / R6

Encapsulated object-oriented programming for R
https://R6.r-lib.org
Other
407 stars 56 forks source link

Documentation of methods #2

Closed paulstaab closed 4 years ago

paulstaab commented 10 years ago

I was wondering if there is a way to to add some documentation/help/instructions to methods of R6 classes? If not, is something planed in this direction? I guess that integration into help() might be difficult, but something like the optional string in the first line of reference class methods that can then printed with $help() would be fantastic.

Great package, thanks!

wch commented 10 years ago

I don't know a good solution offhand... you could put method documentation in the class generator help page, but that's obviously not ideal.

Maybe you could make a help page for each method, and then link to those help pages from the generator's help page?

fkgruber commented 9 years ago

Hi What is the status on documenting R6 classes. Is there any solution at this point? thanks

hadley commented 4 years ago

Please see https://roxygen2.r-lib.org/articles/rd.html#r6