From ripley at stats.ox.ac.uk  Mon May 26 12:51:18 2008
From: ripley at stats.ox.ac.uk (Prof Brian Ripley)
Date: Mon, 26 May 2008 11:51:18 +0100 (BST)
Subject: [Rd] small documentation change: maxCol -> max.col in maxCol.Rd?
In-Reply-To: <20080526103350.GA19149@stats.ox.ac.uk>
References: <20080526103350.GA19149@stats.ox.ac.uk>
Message-ID: <alpine.LFD.1.10.0805261148390.15493@gannet.stats.ox.ac.uk>

The \name is just the name of the documentation.  It does no have to be 
(and often is not) the name of any function.  Further ?maxCol correctly 
produces nothing.

See 'Writing R Extensions' for the formal description of \name.

On Mon, 26 May 2008, Dan Davison wrote:

> There is no function called 'maxCol' in 2.7.0, so should 'maxCol' be purged from maxCol.Rd  and 'max.col' be promoted from an alias (and the file renamed)?
>
> from today's R-devel:
>
> /usr/local/src/R-devel> head ./src/library/base/man/maxCol.Rd
> % File src/library/base/man/maxCol.Rd
> % Part of the R package, http://www.R-project.org
> % Copyright 1995-2007 R Core Development Team
> % Distributed under GPL 2 or later
>
> \name{maxCol}
> \alias{max.col}
> \title{Find Maximum Position in Matrix}
> \description{
>  Find the maximum position for each row of a matrix, breaking ties at random.
>
> Dan
>
> ______________________________________________
> R-devel at r-project.org mailing list
> https://stat.ethz.ch/mailman/listinfo/r-devel
>

-- 
Brian D. Ripley,                  ripley at 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 272866 (PA)
Oxford OX1 3TG, UK                Fax:  +44 1865 272595



[Rd] small documentation change: maxCol -> max.col in maxCol.Rd?
Prof Brian Ripley