Skip to content

Commit

Permalink
Warn again vignette_roclet()
Browse files Browse the repository at this point in the history
Fixes #1445
  • Loading branch information
hadley committed Nov 15, 2023
1 parent 662f567 commit a4afa00
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 4 deletions.
7 changes: 6 additions & 1 deletion R/vignette.R
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
#' Re-build outdated vignettes
#'
#' This rebuilds outdated vignettes with [tools::buildVignette].
#' @description
#' This roclet rebuilds outdated vignettes with [tools::buildVignette],
#' but we no longer recommend it because we no longer recommend storing
#' built vignettes in a package.
#'
#' By default, it will rebuild all vignettes if the source file is newer than
#' the output pdf or html. (This means it will automatically re-build the
#' vignette if you change the vignette source, but _not_ when you
Expand All @@ -11,6 +15,7 @@
#' your package, add `--no-build-vignettes` to the "Build Source Package"
#' field in your project options.
#'
#' @keywords internal
#' @export
vignette_roclet <- function() {
roclet("vignette")
Expand Down
9 changes: 6 additions & 3 deletions man/vignette_roclet.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit a4afa00

Please sign in to comment.