reactR::scaffoldReactWidget() creates devtools::check() warnings

[maxheld83]

Running reactR::scaffoldReactWidget() on an otherwise R CMD check-passing boilerplate package repo, even before running system("yarn install"); system("yarn run webpack") creates a warning (see full log below).
It's not super important, but I think it might remove some friction if setting up the scaffolding kept the package intact warning-free.

You can see the changes I needed to make to the boilerplate to pass devtools::check() in this commit
Comes down to a couple of @inheritParams and friends.
If you agree with this kind of change, I'd be happy to see whether I can work this in a PR.

==> devtools::check()

Updating reacthexgrid documentation
Warning: @param [/Users/max/GitHub/reacthexgrid/R/reacthexgrid.R#31]: mismatched braces or quotes
Writing NAMESPACE
Loading reacthexgrid
Writing NAMESPACE
── Building ──────────── reacthexgrid ──
Setting env vars:
● CFLAGS    : -Wall -pedantic -fdiagnostics-color=always
● CXXFLAGS  : -Wall -pedantic -fdiagnostics-color=always
● CXX11FLAGS: -Wall -pedantic -fdiagnostics-color=always
────────────────────────────────────────
✔  checking for file ‘/Users/max/GitHub/reacthexgrid/DESCRIPTION’ ...
─  preparing ‘reacthexgrid’:
✔  checking DESCRIPTION meta-information ...
─  checking for LF line-endings in source and make files and shell scripts
─  checking for empty or unneeded directories
─  building ‘reacthexgrid_0.0.0.9000.tar.gz’
   
── Checking ──────────── reacthexgrid ──
Setting env vars:
● _R_CHECK_CRAN_INCOMING_USE_ASPELL_: TRUE
● _R_CHECK_CRAN_INCOMING_REMOTE_    : FALSE
● _R_CHECK_CRAN_INCOMING_           : FALSE
● _R_CHECK_FORCE_SUGGESTS_          : FALSE
── R CMD check ─────────────────────────────────────────────────────────────────
* using log directory ‘/Users/max/GitHub/reacthexgrid.Rcheck’
* using R version 3.6.1 (2019-07-05)
* using platform: x86_64-apple-darwin15.6.0 (64-bit)
* using session charset: UTF-8
* using options ‘--no-manual --as-cran’
* checking for file ‘reacthexgrid/DESCRIPTION’ ... OK
* this is package ‘reacthexgrid’ version ‘0.0.0.9000’
* package encoding: UTF-8
* checking package namespace information ... OK
* checking package dependencies ... OK
* checking if this is a source package ... OK
* checking if there is a namespace ... OK
* checking for executable files ... OK
* checking for hidden files and directories ... OK
* checking for portable file names ... OK
* checking for sufficient/correct file permissions ... OK
* checking serialization versions ... OK
* checking whether package ‘reacthexgrid’ can be installed ... OK
* checking installed package size ... OK
* checking package directory ... OK
* checking for future file timestamps ... OK
* checking DESCRIPTION meta-information ... OK
* checking top-level files ... OK
* checking for left-over files ... OK
* checking index information ... OK
* checking package subdirectories ... OK
* checking R files for non-ASCII characters ... OK
* checking R files for syntax errors ... OK
* checking whether the package can be loaded ... OK
* checking whether the package can be loaded with stated dependencies ... OK
* checking whether the package can be unloaded cleanly ... OK
* checking whether the namespace can be loaded with stated dependencies ... OK
* checking whether the namespace can be unloaded cleanly ... OK
* checking dependencies in R code ... OK
* checking S3 generic/method consistency ... OK
* checking replacement functions ... OK
* checking foreign function calls ... OK
* checking R code for possible problems ... OK
* checking Rd files ... OK
* checking Rd metadata ... OK
* checking Rd line widths ... OK
* checking Rd cross-references ... OK
* checking for missing documentation entries ... OK
* checking for code/documentation mismatches ... OK
* checking Rd \usage sections ... WARNING
Undocumented arguments in documentation object 'reacthexgrid-shiny'
  ‘width’ ‘height’ ‘id’ ‘style’ ‘class’ ‘...’

Undocumented arguments in documentation object 'reacthexgrid'
  ‘message’ ‘width’ ‘height’ ‘elementId’

Functions with \usage entries need to have the appropriate \alias
entries, and all their arguments documented.
The \usage entries must correspond to syntactically valid R code.
See chapter ‘Writing R documentation files’ in the ‘Writing R
Extensions’ manual.
* checking Rd contents ... OK
* checking for unstated dependencies in examples ... OK
* checking examples ... NONE
* DONE

Status: 1 WARNING
See
  ‘/Users/max/GitHub/reacthexgrid.Rcheck/00check.log’
for details.


── R CMD check results ──────────────────────────── reacthexgrid 0.0.0.9000 ────
Duration: 12.6s

❯ checking Rd \usage sections ... WARNING
  Undocumented arguments in documentation object 'reacthexgrid-shiny'
    ‘width’ ‘height’ ‘id’ ‘style’ ‘class’ ‘...’
  
  Undocumented arguments in documentation object 'reacthexgrid'
    ‘message’ ‘width’ ‘height’ ‘elementId’
  
  Functions with \usage entries need to have the appropriate \alias
  entries, and all their arguments documented.
  The \usage entries must correspond to syntactically valid R code.
  See chapter ‘Writing R documentation files’ in the ‘Writing R
  Extensions’ manual.

0 errors ✔ | 1 warning ✖ | 0 notes ✔
Error: R CMD check found WARNINGs
Execution halted

Exited with status 1.

> devtools::session_info()
─ Session info ──────────────────────────────────────────────────────────────────────────────────
 setting  value                       
 version  R version 3.6.1 (2019-07-05)
 os       macOS Mojave 10.14.6        
 system   x86_64, darwin15.6.0        
 ui       RStudio                     
 language (EN)                        
 collate  en_US.UTF-8                 
 ctype    en_US.UTF-8                 
 tz       Europe/Berlin               
 date     2019-10-29                  

─ Packages ──────────────────────────────────────────────────────────────────────────────────────
 package     * version    date       lib source                            
 assertthat    0.2.1      2019-03-21 [1] CRAN (R 3.6.0)                    
 backports     1.1.5      2019-10-02 [1] CRAN (R 3.6.0)                    
 callr         3.3.2      2019-09-22 [1] CRAN (R 3.6.0)                    
 cli           1.1.0      2019-03-19 [1] CRAN (R 3.6.0)                    
 clisymbols    1.2.0      2017-05-21 [1] CRAN (R 3.6.0)                    
 crayon        1.3.4      2017-09-16 [1] CRAN (R 3.6.0)                    
 desc          1.2.0      2018-05-01 [1] CRAN (R 3.6.0)                    
 devtools      2.2.1      2019-09-24 [1] CRAN (R 3.6.1)                    
 digest        0.6.22     2019-10-21 [1] CRAN (R 3.6.1)                    
 ellipsis      0.3.0      2019-09-20 [1] CRAN (R 3.6.0)                    
 fs            1.3.1      2019-05-06 [1] CRAN (R 3.6.0)                    
 glue          1.3.1      2019-03-12 [1] CRAN (R 3.6.0)                    
 htmltools     0.4.0      2019-10-04 [1] CRAN (R 3.6.0)                    
 htmlwidgets   1.5.1      2019-10-08 [1] CRAN (R 3.6.0)                    
 magrittr      1.5        2014-11-22 [1] CRAN (R 3.6.0)                    
 memoise       1.1.0      2017-04-21 [1] CRAN (R 3.6.0)                    
 packrat       0.5.0      2018-11-14 [1] CRAN (R 3.6.0)                    
 pkgbuild      1.0.6      2019-10-09 [1] CRAN (R 3.6.0)                    
 pkgload       1.0.2      2018-10-29 [1] CRAN (R 3.6.0)                    
 prettyunits   1.0.2      2015-07-13 [1] CRAN (R 3.6.0)                    
 processx      3.4.1      2019-07-18 [1] CRAN (R 3.6.0)                    
 ps            1.3.0      2018-12-21 [1] CRAN (R 3.6.0)                    
 R6            2.4.0      2019-02-14 [1] CRAN (R 3.6.0)                    
 Rcpp          1.0.2      2019-07-25 [1] CRAN (R 3.6.0)                    
 reactR        0.4.1      2019-07-07 [1] CRAN (R 3.6.0)                    
 remotes       2.1.0      2019-06-24 [1] CRAN (R 3.6.0)                    
 rlang         0.4.1      2019-10-24 [1] CRAN (R 3.6.1)                    
 rprojroot     1.3-2      2018-01-03 [1] CRAN (R 3.6.0)                    
 rstudioapi    0.10       2019-03-19 [1] CRAN (R 3.6.0)                    
 sessioninfo   1.1.1      2018-11-05 [1] CRAN (R 3.6.0)                    
 testthat      2.2.1      2019-07-25 [1] CRAN (R 3.6.0)                    
 usethis       1.5.1.9000 2019-08-22 [1] Github (jimhester/usethis@b25c982)
 withr         2.1.2      2018-03-15 [1] CRAN (R 3.6.0)                    

[1] /Library/Frameworks/R.framework/Versions/3.6/Resources/library

[alandipert]

Hi Max, thank you very much for the report. A PR would be most welcome if you're up for one.

[maxheld83]

note to self: the above commit borks up the html root element; 5bb34a657e5a9dbd50658cc0ff469dcb0691ae2b fixes it and the warnings from devtools::check(), so this should be the base for my PR.