Skip to content

Commit

Permalink
chore: regen docs
Browse files Browse the repository at this point in the history
  • Loading branch information
salim-b committed Mar 5, 2025
1 parent 62f1166 commit 06c8d31
Show file tree
Hide file tree
Showing 14 changed files with 47 additions and 35 deletions.
2 changes: 0 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,8 +63,6 @@ This package borrows a lot of the [Tidyverse](https://www.tidyverse.org/) design

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]: 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.

[^2]: 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.
Expand Down
10 changes: 5 additions & 5 deletions docs/dev/articles/pkgsnip.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/dev/pkgdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ pkgdown: 2.1.1.9000
pkgdown_sha: 87287f602d5889b3ee3ccd82a6c686f6e5874732
articles:
pkgsnip: pkgsnip.html
last_built: 2025-03-04T02:34Z
last_built: 2025-03-05T00:51Z
urls:
reference: https://pkgsnip.rpkg.dev/reference
article: https://pkgsnip.rpkg.dev/articles
4 changes: 2 additions & 2 deletions docs/dev/reference/data_md_snips.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions docs/dev/reference/data_roxy_lbls.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/dev/reference/description_lbl.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 06c8d31

Please sign in to comment.