From 15b02cbc73c3b7dfd85799307c904544830cf2e8 Mon Sep 17 00:00:00 2001
From: Rob Ashton <robertashton94@gmail.com>
Date: Mon, 24 Jun 2024 10:34:57 +0100
Subject: [PATCH] Update docs and regen

---
 R/location.R                        |  2 +-
 R/util.R                            |  2 +-
 man/orderly_location_pull_packet.Rd |  2 +-
 man/orderly_shared_resource.Rd      | 13 ++++++++++---
 4 files changed, 13 insertions(+), 6 deletions(-)

diff --git a/R/location.R b/R/location.R
index f4572b58..a92fa47e 100644
--- a/R/location.R
+++ b/R/location.R
@@ -273,7 +273,7 @@ orderly_location_pull_metadata <- function(location = NULL, root = NULL,
 ##' efficient, as we keep track of files that are copied over even in
 ##' the case of an interrupted pull.
 ##'
-##' @title Pull a single packet from a location
+##' @title Pull one or more packets from a location
 ##'
 ##' @param ... Arguments passed through to
 ##'   [orderly2::orderly_search]. In the special case where the first
diff --git a/R/util.R b/R/util.R
index ee7e8f24..5063c273 100644
--- a/R/util.R
+++ b/R/util.R
@@ -645,7 +645,7 @@ is_testing <- function() {
   identical(Sys.getenv("TESTTHAT"), "true")
 }
 
-#' Given a character vector, missing names are filled using the value.
+# Given a character vector, missing names are filled using the value.
 fill_missing_names <- function(x) {
   if (is.null(names(x))) {
     names(x) <- x
diff --git a/man/orderly_location_pull_packet.Rd b/man/orderly_location_pull_packet.Rd
index a8468ca5..11ee2fa0 100644
--- a/man/orderly_location_pull_packet.Rd
+++ b/man/orderly_location_pull_packet.Rd
@@ -2,7 +2,7 @@
 % Please edit documentation in R/location.R
 \name{orderly_location_pull_packet}
 \alias{orderly_location_pull_packet}
-\title{Pull a single packet from a location}
+\title{Pull one or more packets from a location}
 \usage{
 orderly_location_pull_packet(
   ...,
diff --git a/man/orderly_shared_resource.Rd b/man/orderly_shared_resource.Rd
index a30d15b0..167b4724 100644
--- a/man/orderly_shared_resource.Rd
+++ b/man/orderly_shared_resource.Rd
@@ -7,9 +7,16 @@
 orderly_shared_resource(...)
 }
 \arguments{
-\item{...}{Named arguments corresponding to shared resources to
-copy. The name will be the destination filename, while the value
-is the filename within the shared resource directory.}
+\item{...}{The shared resources to copy. If arguments are named, the name
+will be the destination file while the value is the filename within the
+shared resource directory.
+
+You can use a limited form of string interpolation in the names of
+this argument; using \verb{$\{variable\}} will pick up values from
+\code{envir} and substitute them into your string.  This is similar
+to the interpolation you might be familiar with from
+\code{glue::glue} or similar, but much simpler with no concatenation
+or other fancy features supported.}
 }
 \value{
 Invisibly, a data.frame with columns \code{here} (the fileames