Merge pull request #204 from mrc-ide/gh-203

Make orderly_resource docs more explicit
mrc-ide · Jan 6, 2025 · 48cb8fb · 48cb8fb
2 parents d9ab97c + 5a7cafd
commit 48cb8fb
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 3 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,6 +1,6 @@
 Package: orderly2
 Title: Orderly Next Generation
-Version: 1.99.59
+Version: 1.99.60
 Authors@R: c(person("Rich", "FitzJohn", role = c("aut", "cre"),
                     email = "[email protected]"),
              person("Robert", "Ashton", role = "aut"),

diff --git a/R/metadata.R b/R/metadata.R
@@ -155,7 +155,9 @@ static_orderly_description <- function(args) {
 ##'
 ##' @title Declare orderly resources
 ##'
-##' @param files Any number of names of files
+##' @param files Any number of names of files or directories.  If you
+##'   list a directory it is expanded recursively to include all
+##'   subdirectories and files.
 ##'
 ##' @return Invisibly, a character vector of resources included by the
 ##'   call. Don't rely on the order of these files if they are

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