Skip to content

Commit d406ff5

Browse files
committed
use new function names in vignette
1 parent 57a604d commit d406ff5

1 file changed

Lines changed: 6 additions & 6 deletions

File tree

vignettes/autoqmd.qmd

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,7 @@ out_files <- autoqmd_generate_children(
189189
)
190190

191191
# Include child files in report with page breaks
192-
autoqmd_insert_includes(
192+
autoqmd_insert_children(
193193
target_file = "iris_chapter.qmd",
194194
child_files = out_files,
195195
template = "_species_template.qmd"
@@ -384,7 +384,7 @@ out_files <- autoqmd_generate_children(
384384
)
385385
386386
# Insert includes into the chapter
387-
autoqmd_insert_includes(
387+
autoqmd_insert_children(
388388
target_file = "iris_chapter.qmd",
389389
child_files = out_files,
390390
template = "_species_template.qmd"
@@ -420,7 +420,7 @@ When child documents are inserted into the main chapter, a dependency timestamp
420420

421421
This timestamp records the modification time of the template used to generate the child files. It can be used to detect when a frozen child document may no longer be valid because its template has changed.
422422

423-
In addition to the template itself, users can specify external resources that influence the generated content, such as R scripts loaded with `source()` or data files read from disk. These can be declared via the `template_deps` argument in the `autoqmd_insert_includes()` or `autoqmd_prepare()` functions. When `template_deps` is supplied, modification times of the listed files are recorded alongside the template timestamp. This makes all relevant inputs explicit and helps track when autogenerated content depends on files outside the template.
423+
In addition to the template itself, users can specify external resources that influence the generated content, such as R scripts loaded with `source()` or data files read from disk. These can be declared via the `template_deps` argument in the `autoqmd_insert_children()` or `autoqmd_prepare()` functions. When `template_deps` is supplied, modification times of the listed files are recorded alongside the template timestamp. This makes all relevant inputs explicit and helps track when autogenerated content depends on files outside the template.
424424

425425
```r
426426
library(flandersqmd)
@@ -495,7 +495,7 @@ out_files <- autoqmd_generate_children(
495495
)
496496
497497
# Insert entries into the Quarto configuration
498-
autoqmd_insert_includes(
498+
autoqmd_insert_children(
499499
target_file = "_quarto.yml",
500500
child_files = out_files,
501501
child_labels = my_species,
@@ -556,8 +556,8 @@ The `autoqmd_*()` helpers are intentionally minimal, but a number of customisati
556556
| -------- | -------------------------- | ----------------------------- | ---------------------------- |
557557
| Generate | Generated file location | `autoqmd_generate_children()` | `child_dir` |
558558
| Generate | Verbosity | *all helpers* | `quiet` |
559-
| Insert | Marker placement | `autoqmd_insert_includes()` | `start_marker`, `end_marker` |
560-
| Insert | Page breaks | `autoqmd_insert_includes()` | `page_break` |
559+
| Insert | Marker placement | `autoqmd_insert_children()` | `start_marker`, `end_marker` |
560+
| Insert | Page breaks | `autoqmd_insert_children()` | `page_break` |
561561
| Cleanup | Placeholder messages | `autoqmd_finalise()` | `message` |
562562
| Cleanup | Cleanup of generated files | `autoqmd_finalise()` | `child_dir` |
563563

0 commit comments

Comments
 (0)