R devel - Apr 2000 - Rd files with multiple functions?

There was at one time some discussion about supporting documentation of multiple
functions in one Rd file. Is that supported or still in the plans?

Paul Gilbert

-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-
r-devel mailing list -- Read http://www.ci.tuwien.ac.at/~hornik/R/R-FAQ.html
Send "info", "help", or "[un]subscribe"
(in the "body", not the subject !)  To:
r-devel-request@stat.math.ethz.ch
_._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._

>>>>> "PaulG" == Paul Gilbert
<pgilbert@bank-banque-canada.ca> writes:
    PaulG> There was at one time some discussion about supporting
    PaulG> documentation of multiple functions in one Rd file. Is that
    PaulG> supported or still in the plans?

This "happens all the time". 
It's even recommended in some cases (however people `fight' *which*
cases ..).

Just make sure to have an \alias{} *and* a usage line (but just one
\usage{}) for each function.  
For an example, see      src/library/base/man/lm.Rd

Martin
-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-
r-devel mailing list -- Read http://www.ci.tuwien.ac.at/~hornik/R/R-FAQ.html
Send "info", "help", or "[un]subscribe"
(in the "body", not the subject !)  To:
r-devel-request@stat.math.ethz.ch
_._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._

> Date: Fri, 28 Apr 2000 12:51:37 -0400
> From: Paul Gilbert <pgilbert@bank-banque-canada.ca>
> To: Martin Maechler <maechler@stat.math.ethz.ch>, Douglas Bates 
<bates@stat.wisc.edu>
> CC: R-devel <R-devel@stat.math.ethz.ch>
> Subject: Re: [Rd] Rd files with multiple functions?
> 
> >This "happens all the time".
> >It's even recommended in some cases (however people `fight'
*which* cases
..).
> ...
> >For an example, see      src/library/base/man/lm.Rd
> 
> In my version of R src/library/base/man/lm.Rd just has one \name{}  with
> multiple \alias{}s.
> What I meant was truely different functions (all the functions in a
package)
so
> there would be multiple \name{} lines in the file. Is that possible?
No, the \name is the name of the *file*, the \alias'es are the names
of the objects.

Use \name for a topic, that is the package name in your example. See
e.g. Poisson.Rd that has \name{Poisson}, but there is no function
Poisson(), and the functions are named as \alias{}es

-- 
Brian D. Ripley,                  ripley@stats.ox.ac.uk
Professor of Applied Statistics,  http://www.stats.ox.ac.uk/~ripley/
University of Oxford,             Tel:  +44 1865 272861 (self)
1 South Parks Road,                     +44 1865 272860 (secr)
Oxford OX1 3TG, UK                Fax:  +44 1865 272595

-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-
r-devel mailing list -- Read http://www.ci.tuwien.ac.at/~hornik/R/R-FAQ.html
Send "info", "help", or "[un]subscribe"
(in the "body", not the subject !)  To:
r-devel-request@stat.math.ethz.ch
_._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._