Skip to content
Prev 31756 / 63424 Next

Chunk of text won't show up when compiling Rd file

On Mon, 9 Mar 2009, Ben Bryant wrote:

            
So, no information on what went wrong.  Your example works for me in 
R-devel, even on Windows.
\value sections are somewhat special.  In versions < 2 of Rd format it 
starts out as a standard text section but the first \item macro turns 
it into a \describe list. And this *is* how they are documented:

'If a list with multiple values is returned, you can use entries of 
the form

           \item{comp_i}{Description of comp_i.}

for each component of the list returned. Optional text may precede 
this list (see the introductory example for rle).'

I take that to mean that text can only *precede* a list.  You are 
expecting something to work that is AFAICS undocumented and not 
intended to work.


In the current Rd2 conversion additional text after \item sections 
terminates the list, so this behaves more as you want (as a set of 
lists).  However, Rd2 conversion is not released as yet, and almost 
certainly will not be in 2.9.0.  (I don't think the change in 
behaviour has yet been agreed by R-core.)