Merge pull request #408 from stan-dev/use-params-for-doc

Use `@param` when documenting arguments to R6 methods

DESCRIPTION

@@ -1,7 +1,7 @@
 Package: cmdstanr
 Title: R Interface to 'CmdStan'
-Version: 0.2.2
-Date: 2020-12-03
+Version: 0.3.0
+Date: 2020-12-17
 Authors@R: 
     c(person(given = "Jonah", family = "Gabry", role = c("aut", "cre"),
            email = "jsg2201@columbia.edu"),
@@ -26,11 +26,11 @@ Roxygen: list(markdown = TRUE, r6 = FALSE)
 SystemRequirements: CmdStan (https://mc-stan.org/users/interfaces/cmdstan)
 Imports: 
     checkmate,
+    data.table,
     jsonlite (>= 1.2.0),
     posterior (>= 0.1.3),
     processx (>= 3.4.5),
-    R6 (>= 2.4.0),
-    data.table
+    R6 (>= 2.4.0)
 Suggests: 
     bayesplot,
     knitr,

NEWS.md

@@ -1,4 +1,4 @@
-# Items for next tagged release
+# cmdstanr 0.3.0
 
 ### Bug fixes
 
@@ -29,6 +29,10 @@ objects. (#390)
 * The `$optimize()` method now supports all of CmdStan's tolerance-related
 arguments for (L)BFGS. (#398)
 
+* The documentation for the R6 methods now uses `@param`, which allows package
+developers to import the CmdStanR documentation using roxygen2's
+`@inheritParams`. (#408)
+
 # cmdstanr 0.2.2
 
 ### Bug fixes

R/args.R

@@ -829,7 +829,7 @@ validate_seed <- function(seed, num_procs) {
 #' @return An integer vector of length `num_procs`.
 maybe_generate_seed <- function(seed, num_procs) {
   if (is.null(seed)) {
-    seed <- sample(.Machine$integer.max, num_procs)
+    seed <- base::sample(.Machine$integer.max, num_procs)
   } else if (length(seed) == 1 && num_procs > 1) {
     seed <- as.integer(seed)
     seed <- c(seed, seed + 1:(num_procs -1))

R/cmdstanr-package.R

@@ -52,4 +52,4 @@
 #'
 NULL
 
-if (getRversion() >= "2.15.1")  utils::globalVariables(c("self", "private"))
+if (getRversion() >= "2.15.1")  utils::globalVariables(c("self", "private", "super"))