Skip to content

small documentation change: maxCol -> max.col in maxCol.Rd?

2 messages · Dan Davison, Brian Ripley

#
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
#
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: