From 48b391434e9b214c97a3c24cf4f6f7548cac0272 Mon Sep 17 00:00:00 2001
From: Sean Anderson <sean@seananderson.ca>
Date: Tue, 14 Nov 2023 11:19:10 -0800
Subject: [PATCH] Docs [skip ci]

---
 R/fit.R       | 3 ++-
 man/sdmTMB.Rd | 3 ++-
 2 files changed, 4 insertions(+), 2 deletions(-)

diff --git a/R/fit.R b/R/fit.R
index f950b3fb5..4371769e0 100644
--- a/R/fit.R
+++ b/R/fit.R
@@ -124,7 +124,8 @@ NULL
 #'   the TMB object doesn't have to be rebuilt with [predict.sdmTMB()] and
 #'   [get_index()]. If `TRUE`, then `predict_args` must have a `newdata` element
 #'   supplied and `area` can be supplied to `index_args`.
-#'   Most users can ignore this option.
+#'   Most users can ignore this option. The fitted object can be passed directly
+#'   to [get_index()].
 #' @param predict_args A list of arguments to pass to [predict.sdmTMB()] **if**
 #'   `do_index = TRUE`. Most users can ignore this option.
 #' @param index_args A list of arguments to pass to [get_index()] **if**
diff --git a/man/sdmTMB.Rd b/man/sdmTMB.Rd
index 46e341f8d..c9389366b 100644
--- a/man/sdmTMB.Rd
+++ b/man/sdmTMB.Rd
@@ -173,7 +173,8 @@ memory and time when working with large datasets or projection grids since
 the TMB object doesn't have to be rebuilt with \code{\link[=predict.sdmTMB]{predict.sdmTMB()}} and
 \code{\link[=get_index]{get_index()}}. If \code{TRUE}, then \code{predict_args} must have a \code{newdata} element
 supplied and \code{area} can be supplied to \code{index_args}.
-Most users can ignore this option.}
+Most users can ignore this option. The fitted object can be passed directly
+to \code{\link[=get_index]{get_index()}}.}
 
 \item{predict_args}{A list of arguments to pass to \code{\link[=predict.sdmTMB]{predict.sdmTMB()}} \strong{if}
 \code{do_index = TRUE}. Most users can ignore this option.}