Skip to content

Commit 4f5b044

Browse files
committed
fix: old/leftover ids
1 parent b324989 commit 4f5b044

File tree

8 files changed

+23
-24
lines changed

8 files changed

+23
-24
lines changed

R/pkgsnip.gen.R

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -104,14 +104,14 @@ ls_file_snips <- function() {
104104
#' [`child` document option](https://yihui.org/knitr/options/#child-documents):
105105
#'
106106
#' ````rmd
107-
#' ```{r, child = pkgsnip::snip_path("installation-notice_dev-version_gitlab.Rmd")}
107+
#' ```{r, child = pkgsnip::snip_path("pkg-instl-dev-gitlab.Rmd")}
108108
#' ```
109109
#' ````
110110
#'
111111
#' Or you can use them in roxygen2's [`@includeRmd` tag](https://roxygen2.r-lib.org/articles/rd.html#including-external--rmd-md-files):
112112
#'
113113
#' ```r
114-
#' #' @includeRmd `r pkgsnip::snip_path("installation-notice_dev-version_gitlab.Rmd")`
114+
#' #' @includeRmd `r pkgsnip::snip_path("pkg-instl-dev-gitlab.Rmd")`
115115
#' ```
116116
#'
117117
#' @param id Snippet identifier. One of

Rmd/pkgsnip.Rmd

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -130,14 +130,14 @@ ls_file_snips <- function() {
130130
#' [`child` document option](https://yihui.org/knitr/options/#child-documents):
131131
#'
132132
#' ````rmd
133-
#' ```{r, child = pkgsnip::snip_path("installation-notice_dev-version_gitlab.Rmd")}
133+
#' ```{r, child = pkgsnip::snip_path("pkg-instl-dev-gitlab.Rmd")}
134134
#' ```
135135
#' ````
136136
#'
137137
#' Or you can use them in roxygen2's [`@includeRmd` tag](https://roxygen2.r-lib.org/articles/rd.html#including-external--rmd-md-files):
138138
#'
139139
#' ```r
140-
#' #' @includeRmd `r pkgsnip::snip_path("installation-notice_dev-version_gitlab.Rmd")`
140+
#' #' @includeRmd `r pkgsnip::snip_path("pkg-instl-dev-gitlab.Rmd")`
141141
#' ```
142142
#'
143143
#' @param id Snippet identifier. One of

docs/dev/articles/pkgsnip.html

Lines changed: 7 additions & 8 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/dev/pkgdown.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ pkgdown: 2.1.1
33
pkgdown_sha: ~
44
articles:
55
pkgsnip: pkgsnip.html
6-
last_built: 2024-12-13T19:17Z
6+
last_built: 2024-12-13T22:35Z
77
urls:
88
reference: https://pkgsnip.rpkg.dev/reference
99
article: https://pkgsnip.rpkg.dev/articles

docs/dev/reference/snip_path.html

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/dev/search.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

man/snip_path.Rd

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

vignettes/pkgsnip.Rmd

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,25 +29,25 @@ In the following, an overview is given of what's included in this package.
2929
The (R) Markdown file snippets can be used anywhere [(R) Markdown](https://rmarkdown.rstudio.com/) input is supported. For example, you can use them as input to
3030
[knitr](https://yihui.org/knitr/)'s [`child` document option](https://yihui.org/knitr/options/#child-documents):
3131

32-
`r paste0("\x60\x60\x60\x60\n\x60\x60\x60", '{r, child = pkgsnip::snip_path("installation-notice_dev-version_gitlab.Rmd")}\n', "\x60\x60\x60\n\x60\x60\x60\x60")`
32+
`r paste0("\x60\x60\x60\x60\n\x60\x60\x60", '{r, child = pkgsnip::snip_path("pkg-instl-dev-gitlab.Rmd")}\n', "\x60\x60\x60\n\x60\x60\x60\x60")`
3333

34-
When inserting snippets that require the name of the calling package like `"installation-notice_dev-version_gitlab.Rmd"`, you should either use
35-
`pal::build_readme()` to build the `.Rmd` file or manually assign `pkg_metadata <- pal::desc_list()` to the environment passed to
34+
When inserting snippets that require the name of the calling package like `"pkg-instl-dev-gitlab.Rmd"`, you should either use `pal::build_readme()` to build the
35+
`.Rmd` file or manually assign `pkg_metadata <- pal::desc_list()` to the environment passed to
3636
[`devtools::build_rmd()`](https://devtools.r-lib.org/reference/build_rmd.html) or its `...` argument respectively.
3737

3838
You can also use the snippets in [roxygen2](https://roxygen2.r-lib.org/)'s [`@includeRmd`
3939
tag](https://roxygen2.r-lib.org/articles/rd.html#including-external--rmd-md-files):
4040

4141
``` rd
42-
#' @includeRmd `r '\x60r pkgsnip::snip_path("rmd-package-notice.Rmd")\x60'`
42+
#' @includeRmd `r '\x60r pkgsnip::snip_path("pkgpurl.Rmd")\x60'`
4343
```
4444

4545
For snippets that require the name of the calling package, just assign `pkg_metadata` (once) before inserting the snippet(s), e.g. like this:
4646

4747
``` rd
4848
#' `r "\x60r pkg_metadata <- pal::desc_list()\x60"`
4949
#'
50-
#' @includeRmd `r '\x60r pkgsnip::snip_path("installation-notice_dev-version.Rmd")\x60'`
50+
#' @includeRmd `r '\x60r pkgsnip::snip_path("pkg-instl-dev.Rmd")\x60'`
5151
```
5252

5353
### Available snippets

0 commit comments

Comments
 (0)