Refactor use_vignette()
#1700
Merged
Refactor use_vignette()
#1700
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jennybc
commented
Nov 8, 2022
| @@ -26,6 +26,8 @@ use_vignette <- function(name, title = name) { | |||
| check_vignette_name(name) | |||
|
|
|||
| use_dependency("knitr", "Suggests") | |||
| use_dependency("rmarkdown", "Suggests") | |||
There was a problem hiding this comment.
I hoisted this up out of a helper.
| if (!"rmarkdown" %in% deps$package) { | ||
| ui_done(" | ||
| Adding {ui_value('rmarkdown')} to {ui_field('Config/Needs/website')}") | ||
| use_description_list("Config/Needs/website", "rmarkdown") |
There was a problem hiding this comment.
Since we're doing this here in use_article() specifically, we know enough to avoid adding markdown as an actual dependency in the case of an "articles only" package. I.e. then you only need it in Config/Needs/website.
There was a problem hiding this comment.
This seems worthy of a news bullet.
|
|
||
| if (!is.null(subdir)) { |
There was a problem hiding this comment.
Drive-by change. I just prefer if (TRUE) instead of if (!TRUE).
jennybc
commented
Nov 8, 2022
| @@ -54,15 +63,13 @@ use_vignette_template <- function(template, name, title, subdir = NULL) { | |||
| use_directory(path("vignettes", subdir)) | |||
| } | |||
| use_git_ignore(c("*.html", "*.R"), directory = "vignettes") | |||
| use_dependency("rmarkdown", "Suggests") | |||
There was a problem hiding this comment.
I can't think of any reason why we did this here specifically 🤔
hadley
approved these changes
Nov 8, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivated by experiments made while updating R Packages
Basically I found it confusing that knitr was added to
DESCRIPTIONearly on and then ... later ... rmarkdown was added.I can't think of any reason why we had it this way and looking through git blame didn't shed any light either.
This seems more obvious and obviously correct to me.
BEFORE
AFTER