From spluque at gmail.com  Fri Nov 14 07:29:22 2008
From: spluque at gmail.com (Sebastian P. Luque)
Date: Fri, 14 Nov 2008 00:29:22 -0600
Subject: [Rd] multiple item lists in value section of *.Rd
Message-ID: <874p2azupp.fsf@patagonia.sebmags.homelinux.org>

Hi,

If an *.Rd file documents more than one object, and each object returns
several objects, which should ideally be described in an itemized list.
When documenting single objects, I've been doing this using simple
\item(s) inside the value section, like:

\value{This function returns:

  \item{1st}{one}

  \item{2nd}{two.}

}

How should more than one itemized list be written?  The manual says that
a small introductory phrase can precede the \item(s), but it doesn't
show what to do when we have 2 lists, requiring 2 introductory phrases.
Something like:

\value{One function returns:

  \item{1st}{one}

  \item{2nd}{two.}

  Another function returns:

  \item{1st}{one}

  \item{2nd}{two.}

}


Any suggestions welcome.


Cheers,

-- 
Seb



[Rd] multiple item lists in value section of *.Rd
Sebastian P. Luque