Documentation about box HOT 3 CLOSED

I also saw this package in the same SO question. I'd argue that using roxygen2 would capitalize on a lot of roxy-to-Rd conversions. As far as how to call it, I think something similar to Hadley's devtools would work, where utils::help is masked by devtools:help, which checks to see if it's a devtools-installed help file and falls back to utils::help otherwise.

from box.

Like @r2evans, I think the right way is to use established tools – i.e. roxygen2. And yes, I’ll probably copy devtools’ mechanism of hooking into help, although I would have preferred if R provided a direct way of attaching documentation (or other meta data) to a function, instead of having to patch core functions.

With that in mind, I actually like flydoc’s approach of making such meta information accessible at runtime. This won’t be the priority but it’s definitely “nice to have”.

from box.

The work for this is currently being done in the branch help. I’m closing this issue for now. Further discussion should take place in #32, or in dedicated issues.

At the time of writing, a rudimentary system of the interactive help works (modulo the issues already reported). I won’t push it into master yet until these issues are resolved.

from box.