From bjg at network-theory.co.uk  Tue Dec  9 15:45:52 2003
From: bjg at network-theory.co.uk (bjg@network-theory.co.uk)
Date: Tue Dec  9 15:44:28 2003
Subject: [Rd] documentation fixes (cvs) (PR#5632)
Message-ID: <20031209144552.7BD50F4DB@slim.kubism.ku.dk>

The patch below attempts to correct some unclear sentences in the R
documentation.

In the case of coplot.Rd it wasn't clear whether "shingle" bar had a
special meaning or was a typo for "single". I've just put a comment in
that case.

regards
-- 
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/Random.Rd
===================================================================
RCS file: /cvs/R/src/library/base/man/Random.Rd,v
retrieving revision 1.40
diff -u -r1.40 Random.Rd
--- src/library/base/man/Random.Rd	2003/12/09 09:11:10	1.40
+++ src/library/base/man/Random.Rd	2003/12/09 14:37:13
@@ -147,7 +147,8 @@
   represent the type of normal generator (starting at \code{0}).
 
   In the underlying C, \code{.Random.seed[-1]} is \code{unsigned};
-  therefore in \R \code{.Random.seed[-1]} can be negative.
+  therefore in \R \code{.Random.seed[-1]} can be negative, due to
+  the coercion of an unsigned integer into a signed integer.
 
   \code{RNGkind} returns a two-element character vector of the RNG and
   normal kinds in use \emph{before} the call, invisibly if either
Index: src/library/base/man/strwrap.Rd
===================================================================
RCS file: /cvs/R/src/library/base/man/strwrap.Rd,v
retrieving revision 1.2
diff -u -r1.2 strwrap.Rd
--- src/library/base/man/strwrap.Rd	2003/07/08 00:20:19	1.2
+++ src/library/base/man/strwrap.Rd	2003/12/09 14:37:14
@@ -30,8 +30,8 @@
 }
 \details{
   Whitespace in the input is destroyed.  Double spaces after periods
-  (thought as representing sentence ends) are preserved.  Currently, it
-  possible sentence ends at line breaks are not considerd specially.
+  (representing sentence ends) are preserved.  Currently, sentence
+  ends at line breaks are not considered specially.
   
   Indentation is relative to the number of characters in the prefix
   string.
Index: src/library/graphics/man/coplot.Rd
===================================================================
RCS file: /cvs/R/src/library/graphics/man/coplot.Rd,v
retrieving revision 1.1
diff -u -r1.1 coplot.Rd
--- src/library/graphics/man/coplot.Rd	2003/12/09 07:24:22	1.1
+++ src/library/graphics/man/coplot.Rd	2003/12/09 14:37:14
@@ -56,6 +56,7 @@
   \item{pch}{a vector of plotting symbols or characters.  If too short,
     the values are recycled.}
   \item{bar.bg}{a named vector with components \code{"num"} and
+% what is a "shingle" bar?
     \code{"fac"} giving the background colors for the (shingle) bars,
     for \bold{num}eric and \bold{fac}tor conditioning variables respectively.}
   \item{xlab}{character; labels to use for the x axis and the
Index: src/library/stats/man/model.frame.Rd
===================================================================
RCS file: /cvs/R/src/library/stats/man/model.frame.Rd,v
retrieving revision 1.1
diff -u -r1.1 model.frame.Rd
--- src/library/stats/man/model.frame.Rd	2003/12/09 07:24:24	1.1
+++ src/library/stats/man/model.frame.Rd	2003/12/09 14:37:16
@@ -27,8 +27,8 @@
 
   \item{subset}{a specification of the rows to be used: defaults to all
     rows. This can be any valid indexing vector (see
-    \code{\link{[.data.frame}} for the rows of \code{data} or if that is not
-    supplied, a data frame made up of the variables used in \code{formula}.}
+    \code{\link{data.frame}} for the rows of \code{data} or if that is not
+    supplied, a data frame made up of the variables used in \code{formula}).}
 
   \item{na.action}{how \code{NA}s are treated. The default is first,
     any \code{na.action} attribute of \code{data}, second
Index: src/library/stats/man/nafns.Rd
===================================================================
RCS file: /cvs/R/src/library/stats/man/nafns.Rd,v
retrieving revision 1.1
diff -u -r1.1 nafns.Rd
--- src/library/stats/man/nafns.Rd	2003/12/09 07:24:24	1.1
+++ src/library/stats/man/nafns.Rd	2003/12/09 14:37:16
@@ -33,8 +33,8 @@
   the default, \code{"lm"} and \code{"glm"} methods, and by further
   methods in packages \pkg{MASS}, \pkg{rpart} and \pkg{survival}.
 
-  The default methods do nothing.  The method for the \code{na.exclude}
-  action to pad the object with \code{NA}s in the correct positions to
+  The default methods do nothing.  The default method for the \code{na.exclude}
+  action is to pad the object with \code{NA}s in the correct positions to
   have the same number of rows as the original data frame.
 
   Currently \code{naresid} and \code{napredict} are identical, but
Index: src/library/stats/man/nlm.Rd
===================================================================
RCS file: /cvs/R/src/library/stats/man/nlm.Rd,v
retrieving revision 1.1
diff -u -r1.1 nlm.Rd
--- src/library/stats/man/nlm.Rd	2003/12/09 07:24:24	1.1
+++ src/library/stats/man/nlm.Rd	2003/12/09 14:37:16
@@ -17,9 +17,9 @@
     \code{hessian} attributes, these will be used in the calculation of
     updated parameter values.  Otherwise, numerical derivatives are
     used. \code{\link{deriv}} returns a function with suitable
-    \code{gradient} attribute.  This should be a function a vector of
-    the length of \code{p} followed by any other arguments specified
-    in \code{dots}.}
+    \code{gradient} attribute.  This should be a function of a vector of
+    the length of \code{p} followed by any additional parameters specified
+    by the \code{\dots} argument.}
   \item{p}{starting parameter values for the minimization.}
   \item{hessian}{if \code{TRUE}, the hessian of \code{f}
     at the minimum is returned.}


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