[Rcpp-commits] r3627 - pkg/Rcpp/inst/doc/Rcpp-modules

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

Author: edd
Date: 2012-05-29 13:35:36 +0200 (Tue, 29 May 2012)
New Revision: 3627

Modified:
   pkg/Rcpp/inst/doc/Rcpp-modules/Rcpp-modules.Rnw
Log:
add paragraph on direct=TRUE argument to loadRcppModules


Modified: pkg/Rcpp/inst/doc/Rcpp-modules/Rcpp-modules.Rnw
===================================================================
--- pkg/Rcpp/inst/doc/Rcpp-modules/Rcpp-modules.Rnw	2012-05-28 15:30:08 UTC (rev 3626)
+++ pkg/Rcpp/inst/doc/Rcpp-modules/Rcpp-modules.Rnw	2012-05-29 11:35:36 UTC (rev 3627)
@@ -1156,6 +1156,11 @@
 RcppModules: yada, stdVector, NumEx
 \end{verbatim}
 
+The \Sexpr{link("loadRcppModules" )} has a single argument \texttt{direct}
+with a default value of \texttt{TRUE}. With this default value, all content
+from the module is exposed directly in the package namespace. If set to
+\texttt{FALSE}, all content is exposed as components of the module.
+
 \subsubsection{Just expose the module}
 
 Alternatively, it is possible to just expose the module to the user of the package,