R6: Documentation of methods

Created on 31 Jul 2014  ·  3Comments  ·  Source: r-lib/R6

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!

Most helpful comment

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

All 3 comments

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?

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

Was this page helpful?
0 / 5 - 0 ratings

Related issues

gaborcsardi picture gaborcsardi  ·  22Comments

rappster picture rappster  ·  11Comments

rappster picture rappster  ·  3Comments

mb706 picture mb706  ·  4Comments

kenarab picture kenarab  ·  8Comments