[Roxygen-devel] S4 documentation

Hadley Wickham hadley at rice.edu
Mon Jan 2 16:19:32 CET 2012


On Mon, Nov 14, 2011 at 11:57 AM, Michael Lawrence
<lawrence.michael at gene.com> wrote:
>
>
> On Mon, Nov 14, 2011 at 9:21 AM, Hadley Wickham <hadley at rice.edu> wrote:
>>
>> > In roxygen (v1) existing Rd files in the Rd directory are merged with
>> > the documentation generated by roxygen based on the file name and
>> > @rdname.
>> >
>> > Maybe we can implement something similar in roxygen2? Would that help?
>>
>> I really don't like mixing generated and hand-written files in the
>> same directory - it just seems like a recipe for trouble.  (And makes
>> source code control just that much more complicated)
>>
>
> Agreed. It's nice to have the reference along with the other documentation.
> I don't have any opinion on where the templates are located, but I would
> recommend that there is a generic, modular import mechanism that is able to
> parse any type of file into the Rd object model, as long as a driver exists.

https://github.com/klutometis/roxygen/issues/70

-- 
Assistant Professor / Dobelman Family Junior Chair
Department of Statistics / Rice University
http://had.co.nz/


More information about the Roxygen-devel mailing list