[ESS] Wonderful improvement Roxygen in new ESS

Lionel Henry lionel.hry at gmail.com
Thu Nov 5 18:03:47 CET 2015


Please note that this feature won't work correctly in 15.09-1,
unless you use semantic paragraphing.

We now have a more general testing framework in place that will
help us avoid such unfortunate regressions.

So if you edit a lot of roxygen documentation, please use either
semantic roxy paragraphing as described in my previous email, or
use the dev version of ESS.

Lionel


> On 29 oct. 2015, at 16:12, Paul Johnson <pauljohn32 at gmail.com> wrote:
> 
> In case people did not try the new ESS, I find a wonderful enhancement
> in the behavior of M-q in Roxygen markup. There is now smart
> indentation so that a block of text is not smashed into one giant
> paragraph.  That's a great improvement, thanks very much to the
> developer.
> 
> Now an M-q in the markup area gives this excellent output, for example
> 
> ##' @param projSeeds Required. Either an object of class portableSeeds
> ##'     (created by \code{seedCreator}) or a text string giving the
> ##'     name of an R saved file of the appropriate format (created by
> ##'     the seedCreator function).
> ##' @param run Integer indicating which element from the portable seed
> ##'     collection is to be selected
> ##' @param verbose Optional. Print out the state of the current
> ##'     generator. Default = FALSE.
> ##' @return nothing is returned.
> 
> pj
> -- 
> Paul E. Johnson
> Professor, Political Science        Director
> 1541 Lilac Lane, Room 504      Center for Research Methods
> University of Kansas                 University of Kansas
> http://pj.freefaculty.org              http://crmda.ku.edu
> 
> ______________________________________________
> ESS-help at r-project.org mailing list
> https://stat.ethz.ch/mailman/listinfo/ess-help



More information about the ESS-help mailing list