Skip to content

Commit

Permalink
Update vignettes.Rmd (#1090)
Browse files Browse the repository at this point in the history
Added the missing FALSE to the clean_doc argument on line 439 when discussing preventing the cleaning of `int/doc/`
  • Loading branch information
brubakerconnor authored Nov 12, 2024
1 parent 216bbc7 commit d6e3d3f
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion vignettes.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -436,7 +436,7 @@ However, we acknowledge that there are exceptions to every rule.
In some domains, it might be impractical to rebuild vignettes as often as our recommended workflow implies.
Here are a few tips:
- You can prevent the cleaning of `inst/doc/` with `pkgbuild::build(clean_doc =)`.
- You can prevent the cleaning of `inst/doc/` with `pkgbuild::build(clean_doc = FALSE)`.
You can put `Config/build/clean-inst-doc: FALSE` in `DESCRIPTION` to prevent pkgbuild and rcmdcheck from cleaning `inst/doc/`.
- The rOpenSci tech note [How to precompute package vignettes or pkgdown articles](https://ropensci.org/blog/2019/12/08/precompute-vignettes/) describes a clever, lightweight technique for keeping a manually-updated vignette in `vignettes/`.
Expand Down

0 comments on commit d6e3d3f

Please sign in to comment.