Indicate argument type (#1940)

* Indicate argument type Make it clear that `min_version` expects a character vector, and not a double/integer when specifying exact versions. * Correct typo * Rebuild docs * Tweak wording --------- Co-authored-by: Jenny Bryan <[email protected]>
r-lib · Jul 24, 2024 · 93f4410 · 93f4410
1 parent acac3f9
commit 93f4410
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/R/package.R b/R/package.R
@@ -23,7 +23,8 @@
 #'   "Suggests", "Enhances", or "LinkingTo" (or unique abbreviation). Matching
 #'   is case insensitive.
 #' @param min_version Optionally, supply a minimum version for the package. Set
-#'   to `TRUE` to use the currently installed version.
+#'   to `TRUE` to use the currently installed version or use a version string
+#'   suitable for [numeric_version()], such as "2.5.0".
 #' @param remote By default, an `OWNER/REPO` GitHub remote is inserted.
 #'   Optionally, you can supply a character string to specify the remote, e.g.
 #'   `"gitlab::jimhester/covr"`, using any syntax supported by the [remotes

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