Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix override when included in as_pkgdown #2406

Merged
merged 6 commits into from
Mar 11, 2024
Merged

fix override when included in as_pkgdown #2406

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
9f4c5cb
actually functional override
dsweber2 Mar 1, 2024
1947335
meta may be null
dsweber2 Mar 1, 2024
17e2b10
basic override as_pkgdown test
dsweber2 Mar 1, 2024
1162aea
modifyList -> modify_list, right test location
dsweber2 Mar 11, 2024
135b116
modify_list: test both args for `NULL`
dsweber2 Mar 11, 2024
0140e0c
modify_list: if one is `NULL` return the other
dsweber2 Mar 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion R/package.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
#' @export
as_pkgdown <- function(pkg = ".", override = list()) {
if (is_pkgdown(pkg)) {
pkg$meta <- modify_list(pkg$meta, override)
return(pkg)
}

Expand All @@ -21,7 +22,7 @@ as_pkgdown <- function(pkg = ".", override = list()) {

desc <- read_desc(pkg)
meta <- read_meta(pkg)
meta <- utils::modifyList(meta, override)
meta <- modify_list(meta, override)

template_config <- find_template_config(
package = meta$template$package,
Expand Down
2 changes: 1 addition & 1 deletion R/utils.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ isFALSE <- function(x) {
}

modify_list <- function(x, y) {
if (is.null(y)) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If x is NULL I think you should return y?

if (is.null(x) || is.null(y)) {
return(x)
}

Expand Down
9 changes: 9 additions & 0 deletions tests/testthat/test-package.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,15 @@ test_that("package_vignettes() sorts articles alphabetically by file name", {
)
})

test_that("override works correctly for as_pkgdown", {
pkgdown <- as_pkgdown("assets/man-figures")
expected_list <- list(figures = list(dev = "jpeg", fig.ext = "jpg", fig.width = 3, fig.asp = 1))
expect_equal(pkgdown$meta, expected_list)
modified_pkgdown <- as_pkgdown(pkgdown, override = list(figures = list(dev = "png")))
modified_list <- list(figures = list(dev = "png", fig.ext = "jpg", fig.width = 3, fig.asp = 1))
modified_pkgdown$meta
expect_equal(modified_pkgdown$meta, modified_list)
})
# titles ------------------------------------------------------------------

test_that("multiline titles are collapsed", {
Expand Down
Loading