update man to note pb_update will be ignored if less than or equal to…

… thinning rate
rdpeng · May 28, 2019 · 7ac6cd6 · 7ac6cd6
1 parent 2e163a0
commit 7ac6cd6
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 2 deletions.
diff --git a/R/inference.R b/R/inference.R
@@ -31,7 +31,10 @@ greta_stash$numerical_messages <- c("is not invertible",
 #' @param n_cores the maximum number of CPU cores used by each sampler (see
 #'   details).
 #' @param verbose whether to print progress information to the console
-#' @param pb_update how regularly to update the progress bar (in iterations)
+#' @param pb_update how regularly to update the progress bar (in iterations).
+#'   If \code{pb_update} is less than or equal to \code{thin}, it will be set
+#'   to \code{thin + 1} to ensure at least one saved iteration per
+#'   \code{pb_update} iterations.
 #' @param one_by_one whether to run TensorFlow MCMC code one iteration at a
 #'   time, so that greta can handle numerical errors as 'bad' proposals (see
 #'   below).

diff --git a/man/inference.Rd b/man/inference.Rd