From 18ec1d1a502d2764809999791b06a4cb769afe04 Mon Sep 17 00:00:00 2001 From: Charlie Pauvert Date: Tue, 4 Jul 2023 15:14:46 +0200 Subject: [PATCH 1/2] fix mentions of deprecated function `check_` --- README.Rmd | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.Rmd b/README.Rmd index 8f553629b..563c0c9dc 100644 --- a/README.Rmd +++ b/README.Rmd @@ -159,7 +159,7 @@ The functions in {sandpaper} have the following prefixes: - `create_` will create/amend files or folders in your workspace - `update_` will update build resources in the lesson - `build_` will build files from your source - - `check_` validates either the elements of the lesson and/or episodes + - `validate_` will check the validity of either the elements of the lesson and/or episodes - `fetch_` will download files or resources from the internet - `reset_` removes files or information - `get_` will retrieve information from your source files as an R object @@ -184,7 +184,7 @@ Accessors **Website Creation and Validation** - - `check_lesson()` checks and validates the source files and lesson structure + - `validate_lesson()` checks and validates the source files and lesson structure - `build_episode_md()` renders an individual file to markdown (internal use) - `build_episode_html()` renders a built markdown file to html (internal use) - `build_lesson()` builds the lesson into a static website @@ -325,7 +325,7 @@ The typical workflow will look like this: ```{r} -sandpaper::check_lesson() # validates the structure of the input files +sandpaper::validate_lesson() # validates the structure of the input files sandpaper::build_lesson() # builds and validates lesson ``` From 8eefcf6182b1697e41080312a6d2e45e5d8728ba Mon Sep 17 00:00:00 2001 From: cpauvert Date: Tue, 4 Jul 2023 15:22:16 +0200 Subject: [PATCH 2/2] fix recurrent package typo --- _pkgdown.yml | 2 +- inst/workflows/README.md | 2 +- tests/testthat/_snaps/manage_deps.md | 4 ++-- tests/testthat/test-manage_deps.R | 2 +- vignettes/building-with-renv.Rmd | 2 +- 5 files changed, 6 insertions(+), 6 deletions(-) diff --git a/_pkgdown.yml b/_pkgdown.yml index 104d19518..dc509bfc3 100644 --- a/_pkgdown.yml +++ b/_pkgdown.yml @@ -48,7 +48,7 @@ reference: - reset_episodes - reset_site - strip_prefix - - title: "The Pacakge Cache" + - title: "The Package Cache" desc: > Lessons with generated content (R Markdown lessons) have an extra file called `renv/profiles/lesson-requirments/renv.lock` that records the diff --git a/inst/workflows/README.md b/inst/workflows/README.md index 101967e4b..d6edf88dd 100644 --- a/inst/workflows/README.md +++ b/inst/workflows/README.md @@ -96,7 +96,7 @@ are okay. This update is run ~~weekly or~~ on demand. -### 03 Maintain: Update Pacakge Cache (update-cache.yaml) +### 03 Maintain: Update Package Cache (update-cache.yaml) For lessons that have generated content, we use {renv} to ensure that the output is stable. This is controlled by a single lockfile which documents the packages diff --git a/tests/testthat/_snaps/manage_deps.md b/tests/testthat/_snaps/manage_deps.md index cc0912ec2..5a83bc820 100644 --- a/tests/testthat/_snaps/manage_deps.md +++ b/tests/testthat/_snaps/manage_deps.md @@ -1,4 +1,4 @@ -# pacakge cache message appears correct [plain] +# package cache message appears correct [plain] Code cat(paste(c("1:", "2:"), sandpaper:::message_package_cache(msg)), sep = "\n") @@ -29,7 +29,7 @@ 1: Yes, please use the package cache (recommended) 2: No, I want to use my default library -# pacakge cache message appears correct [ansi] +# package cache message appears correct [ansi] Code cat(paste(c("1:", "2:"), sandpaper:::message_package_cache(msg)), sep = "\n") diff --git a/tests/testthat/test-manage_deps.R b/tests/testthat/test-manage_deps.R index 6f9dc2ab6..cbb47f427 100644 --- a/tests/testthat/test-manage_deps.R +++ b/tests/testthat/test-manage_deps.R @@ -1,6 +1,6 @@ lsn <- restore_fixture() -cli::test_that_cli("pacakge cache message appears correct", { +cli::test_that_cli("package cache message appears correct", { msg <- readLines(system.file("resources/WELCOME", package = "renv")) msg <- gsub("${RENV_PATHS_ROOT}", dQuote("/path/to/cache"), msg, fixed = TRUE) diff --git a/vignettes/building-with-renv.Rmd b/vignettes/building-with-renv.Rmd index 7b2006f4f..5fc7d206a 100644 --- a/vignettes/building-with-renv.Rmd +++ b/vignettes/building-with-renv.Rmd @@ -294,7 +294,7 @@ package_cache_trigger(FALSE) # prevent package cache from triggering rebuilds You might want to set this to `TRUE` when you pull changes from upstream. -## Adding New Pacakges to the Cache +## Adding New Packages to the Cache The {sandpaper} cache records ONLY the packages needed for the repository itself. This means that if you want to use a package, you _must_ have it declared