Deprecate build_vignettes() and clean_vignettes()
#2648
Conversation
| install = TRUE, | ||
| keep_md = TRUE | ||
| ) { | ||
| lifecycle::deprecate_warn("2.5.0", "build_vignettes()") |
There was a problem hiding this comment.
Do we want to point folks towards pkgdown::build_article() here?
| #' `build_vignettes()` is deprecated because we no longer recommend that you | ||
| #' build and check in vignettes. Instead, use `pkgdown::build_article()` to |
There was a problem hiding this comment.
This wording feels off. Because you still want to build your vignettes when you're working on them. And build_vignettes() never did any sort of git work, which is how I interpret "check in".
I think the main point is the we believe that previewing a vignette via pkgdown::build_article() is safer, in terms of the files and folders it touches. build_article() still lets you preview the vignette, but doesn't leave your source package in an unnatural state, with weird folders and files that are normally only present in a package bundle.
| # devtools (development version) | ||
|
|
||
| * `build_manual()` reports more details on failure (#2586). | ||
| * `build_vignettes()` and `clean_vignettes()` are now deprecated. We no longer recommend building and checking in vignettes; instead use `pkgdown::build_article()` to render articles locally for polishing (#2488). |
There was a problem hiding this comment.
I'd try to get rid of the "checking in" phrasing and just emphasize that pkgdown tooling is a better fit for this job.
Fixes #2488