[Roxygen-devel] Roxygen3 ready for review

[Carl Boettiger]

Hi All,

Is there any chance Roxygen3 could support a bit of markdown syntax?

Being a literate programming technique, Roxygen syntax is clearly designed
to be easily readable in raw format.  As such, having to add \code\link,
\item and other approximately LaTeX syntax of the .Rd files feels wrong.
 I'd love to be able to add links or lists (explaining parameter arguments,
return objects) with the markdown-style syntax instead.  Do others think
this would be useful, or am I missing something?

Just a thought,

Carl

On Mon, Sep 17, 2012 at 10:08 AM, Hadley Wickham <h.wickham at gmail.com>wrote:

> Hi all,
>
> Roxygen3 (which will eventually get merged back into roxygen2) is at a
> state where your comments on the design and implementation would be
> appreciated. The code is at https://github.com/hadley/roxygen3/, and
> there's a brief introduction to the structure in the readme.
>
> The code is fairly complete - the code gives the same output as
> roxygen2 (except for whitespace and that I haven't implemented
> templates yet) on devtools, plyr and ggplot2.  It's about 50% slower
> than roxygen2.
>
> Hadley
>
> --
> RStudio / Rice University
> http://had.co.nz/
> _______________________________________________
> Roxygen-devel mailing list
> Roxygen-devel at lists.r-forge.r-project.org
> https://lists.r-forge.r-project.org/cgi-bin/mailman/listinfo/roxygen-devel
>



-- 
Carl Boettiger
UC Davis
http://www.carlboettiger.info/
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.r-forge.r-project.org/pipermail/roxygen-devel/attachments/20120924/0b6f2088/attachment.html>