spelling check

Author: wlangera

R/autoqmd_insert_includes.R

@@ -24,7 +24,7 @@
 #'
 #' @details
 #' If a template is provided (via the `template` argument),
-#' its modification time and the mtimes of files it sources
+#' its modification time and the `mtimes` of files it sources
 #' (detected by [`autoqmd_dependency_stamp()`]) are added
 #' to the autogenerated block as an invisible HTML comment.
 #' This ensures that Quarto's `freeze:` mechanism correctly

checklist.yml

@@ -36,3 +36,5 @@ spelling:
   ignore:
   - .github
   - LICENSE.md
+  - tests/testthat/species_template.qmd
+  - tests/testthat/iris_chapter.qmd

inst/en_gb.dic

@@ -1 +1,6 @@
 bookdown
+autogenerated
+offs
+Pandoc
+shortname
+standalone

vignettes/articles/autoqmd.qmd

@@ -33,7 +33,7 @@ Autogenerated child `.qmd` files are most useful when a report contains many sec
 Compared to alternatives, this approach offers several advantages:
 
 * Manual copy-paste does not scale and is prone to inconsistencies.
-* Parameterised Quarto documents work well for generating multiple standalone reports, but are less suited for assembling many repeated sections within a single report or book.
+* Parametrised Quarto documents work well for generating multiple standalone reports, but are less suited for assembling many repeated sections within a single report or book.
 * Loops inside a single `.qmd` file can work for simple cases, but often lead to long, hard-to-read documents with complex chunk logic and limited control over section structure, chunk labels, and page breaks.
 
 The `autoqmd_*()` approach trades a small amount of upfront structure for clearer separation of concerns: templates define what a section looks like, pre-render scripts define how many sections are needed, and Quarto handles where they appear in the final output.
@@ -83,10 +83,12 @@ Outside these markers, the document remains entirely under manual control.
 
 ### Step 2: Create template from which to make child documents
 
-Next, define a template .qmd file that describes the structure of one repeated section. This template uses placeholder variables (e.g. `{{species}}` or `{{label}}`) that will be substituted during generation. The template can contain text, code chunks, figures, and cross-references, just like any other Quarto document.
+Next, define a template `.qmd` file that describes the structure of one repeated section. This template uses placeholder variables (e.g. `{{species}}` or `{{label}}`) that will be substituted during generation. The template can contain text, code chunks, figures, and cross-references, just like any other Quarto document.
 
 Example: `species_template.qmd`
 
+<!-- spell-check: ignore:start -->
+
 ```{r}
 #| echo: false
 # nolint start
@@ -133,13 +135,15 @@ ggplot(iris_spec_df, aes(x = Sepal.Length, y = Sepal.Width)) +
 # nolint end
 ```
 
+<!-- spell-check: ignore:end -->
+
 Each generated child document will be a fully valid `.qmd` file derived from this template. Template files are never rendered directly by Quarto; they are only used as blueprints for generating temporary child documents.
 
 ### Step 3: Create pre-render script
 
 Child documents are created and inserted before rendering, using a pre-render script. This script is responsible for:
 
-1. Generating one child .qmd file per entity (here: per species)
+1. Generating one child `.qmd` file per entity (here: per species)
 2. Inserting `{{< include >}}` directives between the markers in the main chapter
 
 This can be done either explicitly or via a convenience wrapper.
@@ -188,7 +192,7 @@ autoqmd_prepare(
 When the pre-render script is executed, the following things happen:
 
 * The directory `child_qmd` is created (if needed)
-* One temporary child .qmd file is generated per species
+* One temporary child `.qmd` file is generated per species
 * The main chapter is updated between the markers only
 
 ```{text}