Skip to content

Commit

Permalink
Merge pull request #487 from cpauvert/fix-typos-and-deprecated-fct
Browse files Browse the repository at this point in the history
Fix typos and deprecated fct `check_` in the README
  • Loading branch information
zkamvar committed Jul 7, 2023
2 parents cb3d6c4 + 8eefcf6 commit 8030c16
Show file tree
Hide file tree
Showing 6 changed files with 9 additions and 9 deletions.
6 changes: 3 additions & 3 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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
```

Expand Down
2 changes: 1 addition & 1 deletion _pkgdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion inst/workflows/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions tests/testthat/_snaps/manage_deps.md
Original file line number Diff line number Diff line change
@@ -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")
Expand Down Expand Up @@ -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")
Expand Down
2 changes: 1 addition & 1 deletion tests/testthat/test-manage_deps.R
Original file line number Diff line number Diff line change
@@ -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)
Expand Down
2 changes: 1 addition & 1 deletion vignettes/building-with-renv.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 8030c16

Please sign in to comment.