chore: regen docs

Author: salim-b

README.md

@@ -1,5 +1,7 @@
 # pkgpurl
 
+[![R-CMD-check](https://github.com/rpkg-dev/pkgpurl/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/rpkg-dev/pkgpurl/actions/workflows/R-CMD-check.yaml)
+
 <a href="https://cran.r-project.org/package=pkgpurl" class="pkgdown-release"><img src="https://r-pkg.org/badges/version/pkgpurl" alt="CRAN Status" /></a>
 
 pkgpurl facilitates R package authoring using a literate programming approach. The main idea behind this is to write all of the R source code in R Markdown files (`Rmd/*.Rmd`), which allows the actual code to be freely mixed with explanatory and supplementary information in expressive Markdown format. The main object of pkgpurl is to provide a standardized way to compile the bare `.R` files from the prose-enhanced and thus more human-oriented `.Rmd` files.
@@ -21,29 +23,29 @@ It is especially powerful in combination with the [Visual R Markdown](https://rs
 
 The relevant editor options which adjust the canonical Markdown generation can either be set
 
--   [per `.Rmd` file](https://rstudio.github.io/visual-markdown-editing/#/markdown?id=writer-options), e.g.
+- [per `.Rmd` file](https://rstudio.github.io/visual-markdown-editing/#/markdown?id=writer-options), e.g.
 
-    ``` rmd
-    ---
-    editor_options:
-      markdown:
-        wrap: 160
-        references:
-          location: section
-        canonical: true
-    ---
-    ```
+  ``` rmd
+  ---
+  editor_options:
+    markdown:
+      wrap: 160
+      references:
+        location: section
+      canonical: true
+  ---
+  ```
 
--   or [per project](https://rstudio.github.io/visual-markdown-editing/#/options?id=project-options) in the usual `PACKAGE_NAME.Rproj` file, e.g.
+- or [per project](https://rstudio.github.io/visual-markdown-editing/#/options?id=project-options) in the usual `PACKAGE_NAME.Rproj` file, e.g.
 
-    ``` ini
-    MarkdownWrap: Column
-    MarkdownWrapAtColumn: 160
-    MarkdownReferences: Section
-    MarkdownCanonical: Yes
-    ```
+  ``` ini
+  MarkdownWrap: Column
+  MarkdownWrapAtColumn: 160
+  MarkdownReferences: Section
+  MarkdownCanonical: Yes
+  ```
 
-    (I’d recommend to set them *per project*, so they apply to the whole package including any `.Rmd` vignettes.)
+  (I’d recommend to set them *per project*, so they apply to the whole package including any `.Rmd` vignettes.)
 
 </details>
 <details>
@@ -179,45 +181,43 @@ All the `.gen.R` suffixed R source code found under [`R/`](https://gitlab.com/rp
 
 ### Coding style
 
-This package borrows a lot of the [Tidyverse](https://www.tidyverse.org/) design philosophies. The R code adheres to the principles specified in the [Tidyverse Design Guide](https://principles.tidyverse.org/) wherever possible and is formatted according to the [Tidyverse Style Guide](https://style.tidyverse.org/) (TSG) with the following exceptions:
+This package borrows a lot of the [Tidyverse](https://www.tidyverse.org/) design philosophies. The R code is guided by the [Tidy design principles](https://design.tidyverse.org/) and is formatted according to the [Tidyverse Style Guide](https://style.tidyverse.org/) (TSG) with the following exceptions:
 
--   Line width is limited to **160 characters**, double the [limit proposed by the TSG](https://style.tidyverse.org/syntax.html#long-lines) (80 characters is ridiculously little given today’s high-resolution wide screen monitors).
+- Line width is limited to **160 characters**, double the [limit proposed by the TSG](https://style.tidyverse.org/syntax.html#long-lines) (80 characters is ridiculously little given today’s high-resolution wide screen monitors).
 
-    Furthermore, the preferred style for breaking long lines differs. Instead of wrapping directly after an expression’s opening bracket as [suggested by the TSG](https://style.tidyverse.org/syntax.html#long-lines), we prefer two fewer line breaks and indent subsequent lines within the expression by its opening bracket:
+  Furthermore, the preferred style for breaking long lines differs. Instead of wrapping directly after an expression’s opening bracket as [suggested by the TSG](https://style.tidyverse.org/syntax.html#long-lines), we prefer two fewer line breaks and indent subsequent lines within the expression by its opening bracket:
 
-    ``` r
-    # TSG proposes this
-    do_something_very_complicated(
-      something = "that",
-      requires = many,
-      arguments = "some of which may be long"
-    )
+  ``` r
+  # TSG proposes this
+  do_something_very_complicated(
+    something = "that",
+    requires = many,
+    arguments = "some of which may be long"
+  )
 
-    # we prefer this
-    do_something_very_complicated(something = "that",
-                                  requires = many,
-                                  arguments = "some of which may be long")
-    ```
+  # we prefer this
+  do_something_very_complicated(something = "that",
+                                requires = many,
+                                arguments = "some of which may be long")
+  ```
 
-    This results in less vertical and more horizontal spread of the code and better readability in pipes.
+  This results in less vertical and more horizontal spread of the code and better readability in pipes.
 
--   Usage of [magrittr’s compound assignment pipe-operator `%<>%`](https://magrittr.tidyverse.org/reference/compound.html) is desirable[^5].
+- Usage of [magrittr’s compound assignment pipe-operator `%<>%`](https://magrittr.tidyverse.org/reference/compound.html) is desirable[^5].
 
--   Usage of [R’s right-hand assignment operator `->`](https://rdrr.io/r/base/assignOps.html) is not allowed[^6].
+- Usage of [R’s right-hand assignment operator `->`](https://rdrr.io/r/base/assignOps.html) is not allowed[^6].
 
--   R source code is *not* split over several files as [suggested by the TSG](https://style.tidyverse.org/package-files.html) but instead is (as far as possible) kept in the single file [`Rmd/pkgpurl.Rmd`](https://gitlab.com/rpkg.dev/pkgpurl/-/tree/master/Rmd/pkgpurl.Rmd) which is well-structured thanks to its [Markdown support](#r-markdown-format).
+- R source code is *not* split over several files as [suggested by the TSG](https://style.tidyverse.org/package-files.html) but instead is (as far as possible) kept in the single file [`Rmd/pkgpurl.Rmd`](https://gitlab.com/rpkg.dev/pkgpurl/-/tree/master/Rmd/pkgpurl.Rmd) which is well-structured thanks to its [Markdown support](#r-markdown-format).
 
 As far as possible, these deviations from the TSG plus some additional restrictions are formally specified in [`pkgpurl::default_linters`](https://pkgpurl.rpkg.dev/reference/default_linters), which is (by default) used in [`pkgpurl::lint_rmd()`](https://pkgpurl.rpkg.dev/reference/lint_rmd), which in turn is the recommended way to lint this package.
 
----
-
 [^1]: Actually, you could write anything you like in any syntax outside of R code chunks as long as you don’t mind the file to be *knittable* (which it doesn’t have to be).
 
 [^2]: It basically sends the (R) Markdown file on a “Pandoc round trip” on every file save.
 
 [^3]: I personally recommend to use the shortcut <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>V</kbd> since it’s not occupied yet by any of the predefined [RStudio shortcuts](https://support.posit.co/hc/en-us/articles/200711853-Keyboard-Shortcuts).
 
-[^4]: The very idea to leverage the R Markdown format to author R packages was originally proposed by Yihui Xie. See his excellent [blog post](https://yihui.name/rlp/) for his point of view on the advantages of literate programming techniques and some practical examples. Note that using `pkgpurl::purl_rmd()` is a less cumbersome alternative to the Makefile approach outlined by him.
+[^4]: The very idea to leverage the R Markdown format to author R packages was originally proposed by Yihui Xie. See his excellent [blog post](https://yihui.org/rlp/) for his point of view on the advantages of literate programming techniques and some practical examples. Note that using `pkgpurl::purl_rmd()` is a less cumbersome alternative to the Makefile approach outlined by him.
 
 [^5]: The TSG [explicitly instructs to avoid this operator](https://style.tidyverse.org/pipes.html#assignment-2) – presumably because it’s relatively unknown and therefore might be confused with the forward pipe operator `%>%` when skimming code only briefly. I don’t consider this to be an actual issue since there aren’t many sensible usage patterns of `%>%` at the beginning of a pipe sequence inside a function – I can only think of creating side effects and relying on [R’s implicit return of the last evaluated expression](https://rdrr.io/r/base/function.html). Therefore – and because I really like the `%<>%` operator – it’s usage is welcome.
 

docs/dev/LICENSE.html

@@ -1,8 +1,8 @@
-pandoc: 3.6.3
-pkgdown: 2.1.1
+pandoc: 3.7.0.1
+pkgdown: 2.1.2
 pkgdown_sha: ~
 articles: {}
-last_built: 2025-02-13T23:49Z
+last_built: 2025-05-19T21:10Z
 urls:
   reference: https://pkgpurl.rpkg.dev/reference
   article: https://pkgpurl.rpkg.dev/articles