On 01/02/2018 12:20 PM, Gabriel Becker wrote:
[ lots deleted...]

Or perhaps you could imagine two help systems, akin to --help and man for
command line tools, one of which is minimalist showing usage, etc,
generated by roxygen comments, and one of which is much more extensive, and
not tied to (what could be extremely large) comments in the same .R file as
the code.

I think the input method and output form should be orthogonal. Several front ends already implement minimalist help (e.g. RStudio displays the usage and description sections from the help page).

I'd rather have the help info coming from a separate file; other people apparently prefer to put it in the .R file. I think both methods should be supported. It makes sense to me to get both types of info from one place, but the author should be able to choose where that is.

Duncan Murdoch

P.S. I've been playing around with Georgi Boshnakov's Rdpack package, putting together an RStudio plug-in to make usage updates trivial. If anyone wants to try it out it's on my Github page for now (dmurdoch/Rdpack), but once it's usable, Georgi has said he will merge it back into his.

R-devel@r-project.org mailing list

Reply via email to