Fix docs

R/compare.R

@@ -31,7 +31,7 @@ compare_filesets <- function(target, current) {
 ##'
 ##' @param target The id of the packet to use in the comparison.
 ##' @param current The id of the other packet against which to compare.
-##' @inheritParams orderly_search_options
+##' @inheritParams orderly_search
 ##' @inheritParams orderly_metadata
 ##' @return An object of class orderly_comparison. The object can be printed to
 ##'  get a summary description of the differences, or passed to

R/interactive.R

@@ -75,7 +75,7 @@ detect_orderly_interactive_path <- function(
 ##'
 ##' @title Set search options for interactive use
 ##'
-##' @inheritParams orderly_search_options
+##' @inheritParams orderly_search
 ##'
 ##' @return Nothing, called for its side effects
 ##' @export

R/query_search.R

@@ -19,6 +19,15 @@
 ##' @inheritParams orderly_query
 ##' @inheritParams orderly_search_options
 ##'
+##' @param fetch_metadata Logical, indicating if we should pull
+##'   metadata immediately before the search. If `location` is given,
+##'   then we will pass this through to
+##'   [orderly2::orderly_location_fetch_metadata] to filter locations
+##'   to update.  If pulling many packets in sequence, you *will* want
+##'   to update this option to `FALSE` after the first pull, otherwise
+##'   it will update the metadata between every packet, which will be
+##'   needlessly slow.
+##'
 ##' @param options **DEPRECATED**. Please don't use this any more, and
 ##'   instead use the arguments `location`, `allow_remote` and
 ##'   `fetch_metadata` directly.
@@ -66,7 +75,7 @@ orderly_search <- function(expr, name = NULL, scope = NULL, subquery = NULL,
 ##'   vector in the `location` argument, or if you have specified
 ##'   `fetch_metadata = TRUE`, otherwise `FALSE`.
 ##'
-##' @param fetch_metadata Logical, indicating if we should pull
+##' @param pull_metadata Logical, indicating if we should pull
 ##'   metadata immediately before the search. If `location` is given,
 ##'   then we will pass this through to
 ##'   [orderly2::orderly_location_fetch_metadata] to filter locations