[Roxygen-devel] usage section and long equasions

Hadley Wickham hadley at rice.edu
Thu Feb 9 15:06:10 CET 2012


2012/2/9 meik michalke <Meik.Michalke at uni-duesseldorf.de>:
> hi hadley,
>
> Am Donnerstag, 9. Februar 2012 05:03:28 schrieb Hadley Wickham:
>> > the first is regarding the automatically generated usage section. this
>> > usally works great, except when an option is very long. some automatic
>> > line breaks and additional indentation would be great here. see this
>> > generated doc, page 70, on the function "readability":
>> >  o http://r.reaktanz.de/pckg/koRpus/koRpus.pdf
>>
>> This is a little tricky because it's hard (in general) to tell when
>> whitespace matters (i.e. inside a string) and when it doesn't (between
>> commas of a list).
>
> sure, but couldn't roxygen2 just ignore spaces inside quotes, then? even if it
> didn't, there're obviously two alternatives: *possibly* seeing a line break to
> many in the PDF, or *definitely* not seeing most of the other options at all.
> i'd prefer it the first way ;-)

Well, it _could_, but that would involve writing a parser because
strings are complicated! i.e. where are the valid breaking spaces in
this vector:

c(" ", ' ', "' '", "\" \"", "\\ ")

Hadley


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


More information about the Roxygen-devel mailing list