From bjg at network-theory.co.uk  Fri Dec  5 17:58:12 2003
From: bjg at network-theory.co.uk (bjg@network-theory.co.uk)
Date: Fri Dec  5 17:56:48 2003
Subject: [Rd] documentation bugs (cvs) (PR#5543)
Message-ID: <20031205165812.3E67EECB4@slim.kubism.ku.dk>

Hi,

Below I've flagged some sentences in the R documentation (from cvs)
which are garbled in some way.  If anyone can clarify what these
sentences should say I'd be grateful.

The problems were picked up as part of the proof-reading of the R
manuals by Ciaran O'Riordan.  After looking at the text neither of us
could figure out what the documentation was meant to say.

-- 
Brian Gough

Network Theory Ltd -- Publishing Free Software Manuals
15 Royal Park
Bristol BS8 3AL
United Kingdom

Tel: +44 (0)117 3179309
Fax: +44 (0)117 9048108
Web: http://www.network-theory.co.uk/

Index: src/library/base/man/merge.Rd
===================================================================
RCS file: /home/cvsroot/R/src/library/base/man/merge.Rd,v
retrieving revision 1.1.1.1
diff -u -r1.1.1.1 merge.Rd
--- src/library/base/man/merge.Rd	7 Nov 2003 11:57:17 -0000	1.1.1.1
+++ src/library/base/man/merge.Rd	5 Dec 2003 16:23:13 -0000
@@ -43,6 +43,7 @@
   that match on the specified columns are extracted, and joined
   together.  If there is more than one match, all possible matches
   contribute one row each.\cr
+% "vector are": singular or plural???
   If the \code{by.*} vector are of length 0, the result, \code{r}, is the
   \dQuote{Cartesian product} of \code{x} and \code{y}, i.e.,
   \code{dim(r) = c(nrow(x)*nrow, ncol(x) + ncol(y))}.
Index: src/library/base/man/paste.Rd
===================================================================
RCS file: /home/cvsroot/R/src/library/base/man/paste.Rd,v
retrieving revision 1.1.1.1
diff -u -r1.1.1.1 paste.Rd
--- src/library/base/man/paste.Rd	7 Nov 2003 11:57:17 -0000	1.1.1.1
+++ src/library/base/man/paste.Rd	5 Dec 2003 16:25:06 -0000
@@ -24,6 +24,7 @@
 }
 \value{
   A character vector of the concatenated values.  Thus will be of length
+% objects are (....) unless ???
   zero if all the objects are unless \code{collapse} is non-NULL, in
   which case it is a single empty string.
 }
Index: src/library/base/man/print.coefmat.Rd
===================================================================
RCS file: /home/cvsroot/R/src/library/base/man/print.coefmat.Rd,v
retrieving revision 1.1.1.1
diff -u -r1.1.1.1 print.coefmat.Rd
--- src/library/base/man/print.coefmat.Rd	7 Nov 2003 11:57:17 -0000	1.1.1.1
+++ src/library/base/man/print.coefmat.Rd	5 Dec 2003 16:26:12 -0000
@@ -43,6 +43,7 @@
     \code{TRUE} \emph{and} \code{x} has at least 4 columns \emph{and}
     the last column name of \code{x} starts with \code{"Pr("}.}
   \item{has.Pvalue}{logical; if \code{TRUE}, the last column of \code{x}
+% should be "iff P.values is TRUE"???
     contains P values; in that case, it is printed \emph{iff}
     \code{P.values} (above).}
   \item{eps.Pvalue}{number,..}
Index: src/library/base/man/sink.Rd
===================================================================
RCS file: /home/cvsroot/R/src/library/base/man/sink.Rd,v
retrieving revision 1.1.1.1
diff -u -r1.1.1.1 sink.Rd
--- src/library/base/man/sink.Rd	7 Nov 2003 11:57:18 -0000	1.1.1.1
+++ src/library/base/man/sink.Rd	5 Dec 2003 16:27:18 -0000
@@ -44,6 +44,7 @@
   there is no stack of connections.
 }
 \value{
+% this sentenced doesn't seem to mean anything?
   For \code{sink}.
 
   For \code{sink.number()} the number (0, 1, 2, \dots) of diversions of


[Rd] documentation bugs (cvs) (PR#5543)
bjg@network-theory.co.uk