Skip to content

Rd: more than one list

2 messages · Christian Hennig, Brian Ripley

Original
Christian Hennig
# 
Dear group,

I would like to document more than one function on one help page using the
Rd language. I tried something like

\value{
  \code{foo1} returns a list with components
  \item{arg1}{Argument 1}
  \item{arg2}{Argument 2}

  \code{foo2} returns a list with components
  \item{arg3}{Argument 3}
  \item{arg4}{Argument 4}
}

Unfortunately this makes the text 
"\code{foo2} returns a list with components" disappear in the help pages.
It seems that, after items are specified, no further text outside of items
can be processed. Is this true? What can I do to get both value lists 
documented without writing a separate page for foo2?

Best,
Christian
Brian Ripley
#
On Tue, 6 Aug 2002, Christian Hennig wrote:

            

      
      
      
    

        
It is true, for the good reason that one page should describe one function,
or one closely grouped set of functions.  There are workarounds (use the
list markup possibilities) but you should be aware that many of the foramts
to which .Rd can be translated (e.g. Sd, Ssgm) will not work correctly.

Best to accept that the restriction has a good reason.