[Rd] Suggested changes to R-lang.texi and R-exts.texi

From: Berwin A Turlach <berwin_at_maths.uwa.edu.au>
Date: Sat 12 Nov 2005 - 10:55:06 GMT


Dear all,

I would like to suggest the following changes to the R documentation:

  1. R-exts.texi: Having had my first experience with uploading a package to ftp://cran.R-project.org/incoming/, I think it would be nice if the documentation pointed out that one should use ftp and not sftp (at least on my machine sftp failed to make a connection) and that one should log in as user 'anonymous' and not 'guest'. As it is, I had to figure this out by trial and error. It would also be nice, if in the phrase "sent a message to cran@r-project.org about it" the e-mail address would be a mailto: URL.

   The patch file attached below would modify R-exts.texi to    incorporate all these chanes.

2) R-lang.texi:

   There was recently a short discussion on one of the R mailing list    by someone who got bitten by partial matching. Looking at    R-lang.texi and the section that explains how function arguments    are matched, I notice that the second step is explained thus:

        "Each named supplied argument is compared to the remaining formal
         arguments using partial matching."
   It might be just me, but when reading a sentence like this I start    to wonder why the qualifier "remaining" is used for formal    arguments but not for named supplied arguments and I am left    momentarily confused. I would like to suggest that the start of    the sentence is changed to "Each remaining named supplied    argument...".

   The patch file attached below would modify R-exts.texi to    incorporate all these chanes.

The patch file attached below was produced by running "svn diff" on my machine in the directory that contains the trunk of the R-devel version of R. So the patch file also includes the patch corresponding to my bugreport #8218

Cheers,

        Berwin

Index: src/library/base/man/complex.Rd


Index: doc/manual/R-lang.texi


 @item @strong{Partial matching on tags}. -Each named supplied argument is compared to the remaining formal +Each remaining named supplied argument is compared to the remaining formal  arguments using partial matching. If the name of the supplied argument  matches exactly with the first part of a formal argument then the two  arguments are considered to be matched. It is an error to have multiple Index: doc/manual/R-exts.texi


-When all the testing is done, upload the @file{.tar.gz} file to +When all the testing is done, upload the @file{.tar.gz} file, using +@code{anonymous} as log-in name and your e-mail address as password, to  

 @example
 @url{ftp://cran.R-project.org/incoming/}
 @end example
 

 @noindent

-and send a message to @url{cran@@r-project.org} about it.  The
-@acronym{CRAN} maintainers will run these tests before putting a
-submission in the main archive.
+(note: use @code{ftp} and not @code{sftp} to connect to this server) and
+send a message to @url{mailto:cran@@r-project.org,,cran@@r-project.org}
+about it. The @acronym{CRAN} maintainers will run these tests before +putting a submission in the main archive.  

 Currently, packages containing compiled code should contain at most one  dot in their name to work smoothly under Windows.



R-devel@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-devel Received on Sat Nov 12 21:59:58 2005

This archive was generated by hypermail 2.1.8 : Sun 13 Nov 2005 - 21:21:07 GMT