minor vignette brush-up for updated pinp (latex) class used

Author: eddelbuettel

ChangeLog

@@ -1,3 +1,12 @@
+2019-10-04  Dirk Eddelbuettel  <[email protected]>
+
+	* vignettes/Rcpp-attributes.Rmd: Correct two unevaluated knitr C++
+	chunks to mode 'Rcpp' rather than the (unregistered) C++ mode
+	* vignettes/Rcpp-extending.Rmd: Minor white-space tweak to avoid
+	paragraph-spacing warnings from latex and its mdframed style
+	* vignettes/Rcpp-modules.Rmd: Idem
+	* vignettes/Rcpp-sugar.Rmd: Idem
+
 2019-10-01  Dirk Eddelbuettel  <[email protected]>
 
 	* DESCRIPTION (Version, Date): Roll minor version

inst/NEWS.Rd

@@ -19,6 +19,8 @@
     \itemize{
       \item The \code{Rcpp-modules} vignette received a major review and
       edit (Riccardo Porreca in \ghpr{982}).
+      \item Minor whitespace alignments and edits were made in three
+      vignettes following the new \pkg{pinp} release (Dirk).
     }
   }
 }

vignettes/Rcpp-attributes.Rmd

@@ -656,7 +656,7 @@ Rcpp attribute compilation will automatically generate a package R_init function
 
 You may however want to add additional C++ code to the package initialization sequence. To do this, you can add the `[[Rcpp::init]]` attribute to functions within your package. For example:
 
-```{cpp, eval = FALSE}
+```{Rcpp, eval = FALSE}
 // [[Rcpp::init]]
 void my_package_init(DllInfo *dll) {
   // initialization code here
@@ -665,7 +665,7 @@ void my_package_init(DllInfo *dll) {
 
 In this case, a call to `my_package_init()` will be added to the end of the automatically generated R_init function within RcppExports.cpp. For example:
 
-```{cpp, eval = FALSE}
+```{Rcpp, eval = FALSE}
 void my_package_init(DllInfo *dll);
 RcppExport void R_init_pkgname(DllInfo *dll) {
     R_registerRoutines(dll, NULL, CallEntries, NULL, NULL);

vignettes/Rcpp-extending.Rmd

@@ -134,8 +134,8 @@ input <- list( x = seq(1, 10, by = 0.5) )
 fx(input)
 ```
 
-The \pkg{Rcpp} converter function `Rcpp::as` and `Rcpp::wrap` have been
-designed to be extensible to user-defined types and third-party types.
+The \pkg{Rcpp} converter functions `Rcpp::as` and `Rcpp::wrap` are
+extensible to user-defined types and third-party types.
 
 # Extending `Rcpp::wrap`
 
@@ -266,7 +266,6 @@ class Foo{
         Foo(SEXP);
 }
 
-
 // this must appear after the specialization, or
 // specialization will not be seen by Rcpp types
 #include <Rcpp.h>

vignettes/Rcpp-modules.Rmd

@@ -487,12 +487,10 @@ A simple usage example is provided below:
 mod <- Module("mod_formals", getDynLib(fx))
 norm <- mod$norm
 norm()
-norm(y = 2)
 norm(x = 2, y = 3)
-args(norm)
 ```
 
-To set formal arguments without default values, simply omit the rhs.
+To set formal arguments without default values, omit the rhs.
 
 ```{Rcpp mod_formals2, eval=FALSE}
 using namespace Rcpp;
@@ -517,7 +515,7 @@ args(norm)
 ```
 
 The ellipsis (`...`) can be used to denote that additional arguments
-are optional; it does not take a default value.
+are optional; it does not take a default value. 
 
 ```{Rcpp mod_formals3, eval=FALSE}
 using namespace Rcpp;
@@ -533,15 +531,14 @@ RCPP_MODULE(mod_formals3) {
 }
 ```
 
-and from the \proglang{R} side:
+This works similarly from the \proglang{R} side where the ellipsis is also understood:
 
 ```{r, eval=FALSE}
 mod <- Module("mod_formals3", getDynLib(fx))
 norm <- mod$norm
 args(norm)
 ```
 
-
 ## Exposing \proglang{C++} classes using Rcpp modules
 
 Rcpp modules also provide a mechanism for exposing \proglang{C++} classes, based

vignettes/Rcpp-sugar.Rmd

@@ -688,11 +688,9 @@ sapply(const Rcpp::VectorBase<RTYPE,_NA_,T>& t,
 
 ### The sapply function
 
-`sapply` is a template function that takes two arguments.
-
-- The first argument is a sugar expression, which we recognize because of 
-  the relationship with the `VectorBase` class template.
-- The second argument is the function to apply.
+`sapply` is a template function that takes two arguments.  The first argument is a sugar
+expression, which we recognize because of the relationship with the `VectorBase` class
+template. The second argument is the function to apply.
 
 The `sapply` function itself does not do anything, it is just used
 to trigger compiler detection of the template parameters that will be used
@@ -712,6 +710,7 @@ typedef typename
 
 The `result_of` type trait is implemented as such:
 
+
 ```{Rcpp, eval = FALSE}
 template <typename T>
 struct result_of{
@@ -769,7 +768,7 @@ typedef typename
 
 ### Input expression base type
 
-The input expression --- the expression over which `sapply` runs --- is
+The input expression---the expression over which `sapply` runs---is
 also typedef'ed for convenience:
 
 ```cpp
@@ -800,6 +799,7 @@ is the manifestation of the _CRTP_.
 
 ### Constructor
 
+ 
 The constructor of the `Sapply` class template is straightforward, it
 simply consists of holding the reference to the input expression and the
 function.