Merged origin/main into lionel--discard-current-pkg

.github/workflows/pkgdown.yaml

@@ -19,6 +19,8 @@ jobs:
       group: pkgdown-${{ github.event_name != 'pull_request' || github.run_id }}
     env:
       GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
+    permissions:
+      contents: write
     steps:
       - uses: actions/checkout@v3
 

.github/workflows/test-coverage.yaml

@@ -31,7 +31,7 @@ jobs:
           covr::codecov(
             quiet = FALSE,
             clean = FALSE,
-            install_path = file.path(Sys.getenv("RUNNER_TEMP"), "package")
+            install_path = file.path(normalizePath(Sys.getenv("RUNNER_TEMP"), winslash = "/"), "package")
           )
         shell: Rscript {0}
 

DESCRIPTION

@@ -18,7 +18,7 @@ License: MIT + file LICENSE
 URL: https://roxygen2.r-lib.org/, https://github.com/r-lib/roxygen2
 BugReports: https://github.com/r-lib/roxygen2/issues
 Depends: 
-    R (>= 3.3)
+    R (>= 3.6)
 Imports: 
     brew,
     cli (>= 3.3.0),
@@ -51,5 +51,4 @@ Config/testthat/edition: 3
 Encoding: UTF-8
 Language: en-GB
 Roxygen: list(markdown = TRUE, load = "installed")
-RoxygenNote: 7.2.2.9000
-SystemRequirements: C++11
+RoxygenNote: 7.2.3.9000

LICENSE

@@ -1,2 +1,2 @@
-YEAR: 2020
+YEAR: 2023
 COPYRIGHT HOLDER: roxygen2 authors

LICENSE.md

@@ -1,6 +1,6 @@
 # MIT License
 
-Copyright (c) 2020 roxygen2 authors
+Copyright (c) 2023 roxygen2 authors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

R/tag-metadata.R

@@ -45,7 +45,7 @@ tags_rd <- function(type) {
     "@aliases",
     tags_rd_section(tags, "aliases"),
     "@description",
-    paste0("Learn full the details in in `vignette('", type, "')`."),
+    paste0("Learn the full details in `vignette('", type, "')`."),
     "",
     if (any(tags$recommend)) c(
       "Key tags:",

README.md

@@ -1,8 +1,8 @@
-# roxygen2 <a href="https://roxygen2.r-lib.org"><img src="man/figures/logo.png" align="right" height="138" /></a>
+# roxygen2 <a href="https://roxygen2.r-lib.org"><img src="man/figures/logo.png" align="right" height="138" alt="roxygen2 website" /></a>
 
 <!-- badges: start -->
 [![CRAN status](https://www.r-pkg.org/badges/version/roxygen2)](https://CRAN.R-project.org/package=roxygen2)
-[![R-CMD-check](https://github.com/r-lib/roxygen2/workflows/R-CMD-check/badge.svg)](https://github.com/r-lib/roxygen2/actions)
+[![R-CMD-check](https://github.com/r-lib/roxygen2/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/r-lib/roxygen2/actions/workflows/R-CMD-check.yaml)
 [![Codecov test coverage](https://codecov.io/gh/r-lib/roxygen2/branch/main/graph/badge.svg)](https://app.codecov.io/gh/r-lib/roxygen2?branch=main)
 <!-- badges: end -->
 

tests/testthat/_snaps/markdown-code.md

@@ -15,7 +15,8 @@
     Output
       
     Message
-      Quitting from lines 1-1 () 
+      
+      Quitting from lines 1-1
     Condition
       Warning:
       [<text>:4] @description failed to evaluate inline markdown code

tests/testthat/_snaps/rd-include-rmd.md

@@ -7,8 +7,10 @@
     Code
       . <- roc_proc_text(rd_roclet(), text)
     Message
-      Quitting from lines 2-3 (<temp-path.Rmd>) 
-      Quitting from lines 2-3 (<temp-path.Rmd>) 
+      
+      Quitting from lines 2-3 [unnamed-chunk-2] (<temp-path.Rmd>)
+      
+      Quitting from lines 2-3 [unnamed-chunk-1] (<temp-path.Rmd>)
     Condition
       Warning:
       [<text>:3] @includeRmd failed to evaluate '<temp-path.Rmd>'

tests/testthat/test-collate.R

@@ -18,7 +18,7 @@ test_that("Collate field unchanged when no @includes", {
   local_package_copy(test_path('testCollateNoIncludes'))
 
   update_collate(".")
-  expect_equal(desc::desc_get_field("Collate"), "b.r a.r")
+  expect_equal(desc::desc_get_field("Collate"), "b.R a.R")
 })
 
 test_that("DESCRIPTION file is re-written only if collate changes", {

tests/testthat/test-object-from-call.R

@@ -168,6 +168,7 @@ test_that("finds arguments when S4 method wrapped inside .local()", {
 # R.oo / R.methodsS3 ------------------------------------------------------
 
 test_that("can define constructor with R.oo", {
+  skip_if_not_installed("R.oo")
   obj <- call_to_object({
     R.oo::setConstructorS3("Foo", function(x, y, z) {})
   })
@@ -176,6 +177,7 @@ test_that("can define constructor with R.oo", {
 })
 
 test_that("can define method for R.methodsS3", {
+  skip_if_not_installed("R.methodsS3")
   obj <- call_to_object({
     R.methodsS3::setMethodS3("foo", "default", function(x, ...) {})
   })

tests/testthat/test-package_files.R

@@ -1,7 +1,7 @@
 test_that("respects order in Collate (#790)", {
   expect_equal(
     package_files('testCollateParse'),
-    normalizePath(c("testCollateParse/R/b.r", "testCollateParse/R/c.r"))
+    normalizePath(c("testCollateParse/R/b.R", "testCollateParse/R/c.R"))
   )
 })
 

tests/testthat/test-rd-include-rmd.R

@@ -1,3 +1,5 @@
+skip_if_not_installed("rmarkdown")
+
 test_that("markdown file can be included", {
   skip_if_not(rmarkdown::pandoc_available("2.17"))
 

tests/testthat/testCollateNoIncludes/DESCRIPTION

@@ -5,4 +5,4 @@ Description:
 Author: Geoff <geoff.lee99@gmail.com>
 Maintainer: Geoff <geoff.lee99@gmail.com>
 Version: 0.1
-Collate: b.r a.r
+Collate: b.R a.R

tests/testthat/testCollateNoIncludes/R/a.r → tests/testthat/testCollateNoIncludes/R/a.R

@@ -1,4 +1,4 @@
 # Manually edited the Collate field in the DESCRIPTION file so this *should*
-# run after b.r
+# run after b.R
 
 a <- 1

tests/testthat/testCollateOverwrite/DESCRIPTION

@@ -6,4 +6,4 @@ Author: Hadley <h.wickham@gmail.com>
 Maintainer: Hadley <h.wickham@gmail.com>
 Version: 0.1
 Collate:
-    'b.r'
+    'b.R'

tests/testthat/testCollateOverwrite/R/a.R

@@ -0,0 +1,2 @@
+#' @include b.R
+a <- 1

tests/testthat/testCollateParse/DESCRIPTION

@@ -8,5 +8,5 @@ Author: Brodie Gaslam <brodie.gaslam@yahoo.com>
 Maintainer: Brodie Gaslam <brodie.gaslam@yahoo.com>
 Version: 0.1
 Collate:
-    'b.r'
-    'c.r'
+    'b.R'
+    'c.R'

vignettes/index-crossref.Rmd

@@ -37,7 +37,7 @@ A function can be a member of multiple families.
 
 By default `@family {family}`, will generate the see also text "Other {family}:", so the `@family` name should be plural (i.e., "model building helpers" not "model building helper").
 
-If you want to override default title, you can provide an `rd_family_title` element in a list stored in `man/roxygen/meta.R`:
+If you want to override the default title, you can provide an `rd_family_title` element in a list stored in `man/roxygen/meta.R`:
 
 ```{r, eval = FALSE}
 list(

vignettes/rd-other.Rmd

@@ -42,6 +42,8 @@ This means you need to document them in a slightly different way: instead of doc
 #'   \item{depth}{total depth percentage = z / mean(x, y) = 2 * z / (x + y) (43--79)}
 #'   \item{table}{width of top of diamond relative to widest point (43--95)}
 #' }
+#' 
+#' @source {ggplot2} tidyverse R package.
 ```
 
 Note the use of two additional tags that are particularly useful for documenting data:

vignettes/rd.Rmd

@@ -80,7 +80,7 @@ This is unnecessary unless you want to have a multi-paragraph description, bulle
 
 ## Functions
 
-Functions are the mostly commonly documented objects.
+Functions are the most commonly documented objects.
 Functions require three tags: `@param`, `@returns`, and `@examples`.
 
 ### Inputs
@@ -134,5 +134,5 @@ All functions must have a documented return value for initial CRAN submission.
 ### Usage
 
 In most case, the function usage (which appears beneath the description in the generates docs) will be automatically derived from the function specification.
-For the cases where it is not, please [file an issue](https://github.com/r-lib/roxygen2/issues) and use `@usage` to override the default with you want.
+For the cases where it is not, please [file an issue](https://github.com/r-lib/roxygen2/issues) and use `@usage` to override the default with what you want.
 If you want to suppress the usage altogether (which is sometimes useful for internal or deprecated functions), you can use `@usage NULL`.

vignettes/reuse.Rmd

@@ -19,7 +19,7 @@ knitr::opts_chunk$set(
 
 roxygen2 provides several ways to avoid repeating yourself in code documentation, while assembling information from multiple places in one documentation file:
 
--   Combine documentation for closely related functions into a single file with `@describe` in or `@rdname`.
+-   Combine documentation for closely related functions into a single file with `@describeIn` or `@rdname`.
 
 -   Inherit components from another topic with `@inheritParams`, `@inheritSection`, or `@inherit`.
 
@@ -37,7 +37,7 @@ Use it when all functions have the same (or very similar) arguments.
 
 ### `@describeIn`
 
-Use `@describeIn <destination> <description>` to document mutiple functions together.
+Use `@describeIn <destination> <description>` to document multiple functions together.
 It generates a new section named "**Related functions and methods**", further divided into subsections by the type of relationship between the source and the destination documentation.
 Each subsection contains a bulleted list describing the function with the specified `<description>`.
 
@@ -170,7 +170,7 @@ Note that the evaluation environment is deliberately a child of the package that
 
 ## Child documents
 
-You can use the same `.Rmd` or `.md` document in the documentation, `README.Rmd`, and vignettes but using child documents:
+You can use the same `.Rmd` or `.md` document in the documentation, `README.Rmd`, and vignettes by using child documents:
 
     ```{r child = "common.Rmd"}`r ''`
     ```