fixes to documentation

stan-dev · Apr 16, 2024 · 0964ad6 · 0964ad6
1 parent d95b029
commit 0964ad6
Show file tree

Hide file tree

Showing 6 changed files with 125 additions and 0 deletions.
diff --git a/R/gpd.R b/R/gpd.R
@@ -53,6 +53,7 @@ qgeneralized_pareto <- function(p, mu = 0, sigma = 1, k = 0, lower.tail = TRUE,
 #' Zhang, J., and Stephens, M. A. (2009). A new and efficient estimation method
 #' for the generalized Pareto distribution. *Technometrics* **51**, 316-325.
 #'
+#' @noRd
 gpdfit <- function(x, wip = TRUE, min_grid_pts = 30, sort_x = TRUE) {
   # see section 4 of Zhang and Stephens (2009)
   if (sort_x) {

diff --git a/R/pareto_smooth.R b/R/pareto_smooth.R
@@ -637,6 +637,7 @@ ps_tail_length <- function(ndraws, r_eff, ...) {
 #' @param are_weights (logical) are the diagnostics for weights
 #' @param ... unused
 #' @return diagnostic message
+#' @noRd
 pareto_k_diagmsg <- function(diags, are_weights = FALSE, ...) {
   khat <- diags$khat
   min_ss <- diags$min_ss

diff --git a/man/ps_convergence_rate.Rd b/man/ps_convergence_rate.Rd
diff --git a/man/ps_khat_threshold.Rd b/man/ps_khat_threshold.Rd
diff --git a/man/ps_min_ss.Rd b/man/ps_min_ss.Rd
diff --git a/man/ps_tail_length.Rd b/man/ps_tail_length.Rd