[Rcpp-commits] r3582 - pkg/Rcpp/man

[noreply at r-forge.r-project.org]

Author: jmc
Date: 2012-04-20 02:31:32 +0200 (Fri, 20 Apr 2012)
New Revision: 3582

Modified:
   pkg/Rcpp/man/loadModule.Rd
   pkg/Rcpp/man/setRcppClass.Rd
Log:
Added note on requiring R 2.15.0

Modified: pkg/Rcpp/man/loadModule.Rd
===================================================================
--- pkg/Rcpp/man/loadModule.Rd	2012-04-19 21:24:22 UTC (rev 3581)
+++ pkg/Rcpp/man/loadModule.Rd	2012-04-20 00:31:32 UTC (rev 3582)
@@ -70,6 +70,11 @@
 If the load takes place, the module environment is returned.  Usually
 however the function is called for its side effects.
 }
+\note{
+This function requires version  2.15.0 of \R{} or later, in order to
+use load actions, introduced in that version.  See the note in the
+help page for \code{\link{setRcppClass}()} for details.
+}
 \author{
 John Chambers
 }

Modified: pkg/Rcpp/man/setRcppClass.Rd
===================================================================
--- pkg/Rcpp/man/setRcppClass.Rd	2012-04-19 21:24:22 UTC (rev 3581)
+++ pkg/Rcpp/man/setRcppClass.Rd	2012-04-20 00:31:32 UTC (rev 3582)
@@ -80,6 +80,21 @@
 \author{
 John Chambers
 }
+\note{
+This function and function \code{\link{loadModule}()} require
+version  2.15.0 of \R{} or later, in order to
+use load actions, introduced in that version.
+
+A subtle way this can fail is by somehow loading a legitimate
+binary version of your package (installed under a valid version of
+\R{}) into a session with an older \R{}.
+In this case the load actions created in the binary package will
+simply not be called.  None of the modules will be loaded and none of
+the classes created.
+
+If your symptom is that classes or other objects from modules don't
+exist, check the \R{} version.
+}
 \examples{
 \dontrun{
 setRcppClass("World",