Merge pull request #1162 from r-lib/fix-roxy-test-comments

Update roxygen test comments
r-lib · Dec 3, 2023 · cfcdb48 · cfcdb48
2 parents d6fee24 + 1c58646
commit cfcdb48
Show file tree

Hide file tree

Showing 30 changed files with 31 additions and 31 deletions.
diff --git a/tests/dev/gen_roxygen_tests.R → tests/dev/generate_roxygen_tests.R b/tests/dev/gen_roxygen_tests.R → tests/dev/generate_roxygen_tests.R
@@ -1,5 +1,5 @@
 #!/usr/bin/Rscript
-# execute from package TLD: ./tests/dev/gen_roxygen_tests.R
+# execute from: ./tests/dev/generate_roxygen_tests.R
 roxygen_stub <- "roxygen-examples-complete"
 all_examples <- list.files(file.path("tests", "testthat", roxygen_stub))
 unique_tests <- unique(sub("-.*", "", all_examples))
@@ -15,7 +15,7 @@ for (test in unique_tests) {
   condition <- condition_map[[test]]
   if (is.null(condition)) condition <- c("warning", "NA")
   writeLines(con = out_file, c(
-    "# NB: DO NOT EDIT. Auto-generated by .dev/gen_roxygen_tests.R.",
+    "# NB: DO NOT EDIT. Auto-generated by ./tests/dev/generate_roxygen_tests.R.",
     "",
     sprintf('test_that("analogous to test-%s: %s", {', roxygen_stub, test),
     sprintf(

diff --git a/tests/testthat/test-roxygen-examples-complete-01.R b/tests/testthat/test-roxygen-examples-complete-01.R
@@ -1,4 +1,4 @@
-# NB: DO NOT EDIT. Auto-generated by .dev/gen_roxygen_tests.R.
+# NB: DO NOT EDIT. Auto-generated by ./tests/dev/generate_roxygen_tests.R.
 
 test_that("analogous to test-roxygen-examples-complete: 01", {
   expect_warning(test_collection("roxygen-examples-complete", "^01-", transformer = style_text), NA)

diff --git a/tests/testthat/test-roxygen-examples-complete-02.R b/tests/testthat/test-roxygen-examples-complete-02.R
@@ -1,4 +1,4 @@
-# NB: DO NOT EDIT. Auto-generated by .dev/gen_roxygen_tests.R.
+# NB: DO NOT EDIT. Auto-generated by ./tests/dev/generate_roxygen_tests.R.
 
 test_that("analogous to test-roxygen-examples-complete: 02", {
   expect_warning(test_collection("roxygen-examples-complete", "^02-", transformer = style_text), NA)

diff --git a/tests/testthat/test-roxygen-examples-complete-03.R b/tests/testthat/test-roxygen-examples-complete-03.R
@@ -1,4 +1,4 @@
-# NB: DO NOT EDIT. Auto-generated by .dev/gen_roxygen_tests.R.
+# NB: DO NOT EDIT. Auto-generated by ./tests/dev/generate_roxygen_tests.R.
 
 test_that("analogous to test-roxygen-examples-complete: 03", {
   expect_warning(test_collection("roxygen-examples-complete", "^03-", transformer = style_text), NA)

diff --git a/tests/testthat/test-roxygen-examples-complete-04.R b/tests/testthat/test-roxygen-examples-complete-04.R
@@ -1,4 +1,4 @@
-# NB: DO NOT EDIT. Auto-generated by .dev/gen_roxygen_tests.R.
+# NB: DO NOT EDIT. Auto-generated by ./tests/dev/generate_roxygen_tests.R.
 
 test_that("analogous to test-roxygen-examples-complete: 04", {
   expect_warning(test_collection("roxygen-examples-complete", "^04-", transformer = style_text), NA)

diff --git a/tests/testthat/test-roxygen-examples-complete-05.R b/tests/testthat/test-roxygen-examples-complete-05.R
@@ -1,4 +1,4 @@
-# NB: DO NOT EDIT. Auto-generated by .dev/gen_roxygen_tests.R.
+# NB: DO NOT EDIT. Auto-generated by ./tests/dev/generate_roxygen_tests.R.
 
 test_that("analogous to test-roxygen-examples-complete: 05", {
   expect_warning(test_collection("roxygen-examples-complete", "^05-", transformer = style_text), NA)

diff --git a/tests/testthat/test-roxygen-examples-complete-06.R b/tests/testthat/test-roxygen-examples-complete-06.R
@@ -1,4 +1,4 @@
-# NB: DO NOT EDIT. Auto-generated by .dev/gen_roxygen_tests.R.
+# NB: DO NOT EDIT. Auto-generated by ./tests/dev/generate_roxygen_tests.R.
 
 test_that("analogous to test-roxygen-examples-complete: 06", {
   expect_warning(test_collection("roxygen-examples-complete", "^06-", transformer = style_text), NA)

diff --git a/tests/testthat/test-roxygen-examples-complete-07.R b/tests/testthat/test-roxygen-examples-complete-07.R
@@ -1,4 +1,4 @@
-# NB: DO NOT EDIT. Auto-generated by .dev/gen_roxygen_tests.R.
+# NB: DO NOT EDIT. Auto-generated by ./tests/dev/generate_roxygen_tests.R.
 
 test_that("analogous to test-roxygen-examples-complete: 07", {
   expect_warning(test_collection("roxygen-examples-complete", "^07-", transformer = style_text), NA)

diff --git a/tests/testthat/test-roxygen-examples-complete-08.R b/tests/testthat/test-roxygen-examples-complete-08.R
@@ -1,4 +1,4 @@
-# NB: DO NOT EDIT. Auto-generated by .dev/gen_roxygen_tests.R.
+# NB: DO NOT EDIT. Auto-generated by ./tests/dev/generate_roxygen_tests.R.
 
 test_that("analogous to test-roxygen-examples-complete: 08", {
   expect_warning(test_collection("roxygen-examples-complete", "^08-", transformer = style_text), NA)

diff --git a/tests/testthat/test-roxygen-examples-complete-09.R b/tests/testthat/test-roxygen-examples-complete-09.R
@@ -1,4 +1,4 @@
-# NB: DO NOT EDIT. Auto-generated by .dev/gen_roxygen_tests.R.
+# NB: DO NOT EDIT. Auto-generated by ./tests/dev/generate_roxygen_tests.R.
 
 test_that("analogous to test-roxygen-examples-complete: 09", {
   expect_warning(test_collection("roxygen-examples-complete", "^09-", transformer = style_text), NA)

diff --git a/tests/testthat/test-roxygen-examples-complete-10.R b/tests/testthat/test-roxygen-examples-complete-10.R
@@ -1,4 +1,4 @@
-# NB: DO NOT EDIT. Auto-generated by .dev/gen_roxygen_tests.R.
+# NB: DO NOT EDIT. Auto-generated by ./tests/dev/generate_roxygen_tests.R.
 
 test_that("analogous to test-roxygen-examples-complete: 10", {
   expect_warning(test_collection("roxygen-examples-complete", "^10-", transformer = style_text), NA)

diff --git a/tests/testthat/test-roxygen-examples-complete-11.R b/tests/testthat/test-roxygen-examples-complete-11.R
@@ -1,4 +1,4 @@
-# NB: DO NOT EDIT. Auto-generated by .dev/gen_roxygen_tests.R.
+# NB: DO NOT EDIT. Auto-generated by ./tests/dev/generate_roxygen_tests.R.
 
 test_that("analogous to test-roxygen-examples-complete: 11", {
   expect_warning(test_collection("roxygen-examples-complete", "^11-", transformer = style_text), NA)

diff --git a/tests/testthat/test-roxygen-examples-complete-12.R b/tests/testthat/test-roxygen-examples-complete-12.R
@@ -1,4 +1,4 @@
-# NB: DO NOT EDIT. Auto-generated by .dev/gen_roxygen_tests.R.
+# NB: DO NOT EDIT. Auto-generated by ./tests/dev/generate_roxygen_tests.R.
 
 test_that("analogous to test-roxygen-examples-complete: 12", {
   expect_warning(test_collection("roxygen-examples-complete", "^12-", transformer = style_text), NA)

diff --git a/tests/testthat/test-roxygen-examples-complete-13.R b/tests/testthat/test-roxygen-examples-complete-13.R
@@ -1,4 +1,4 @@
-# NB: DO NOT EDIT. Auto-generated by .dev/gen_roxygen_tests.R.
+# NB: DO NOT EDIT. Auto-generated by ./tests/dev/generate_roxygen_tests.R.
 
 test_that("analogous to test-roxygen-examples-complete: 13", {
   expect_warning(test_collection("roxygen-examples-complete", "^13-", transformer = style_text), NA)

diff --git a/tests/testthat/test-roxygen-examples-complete-14.R b/tests/testthat/test-roxygen-examples-complete-14.R
@@ -1,4 +1,4 @@
-# NB: DO NOT EDIT. Auto-generated by .dev/gen_roxygen_tests.R.
+# NB: DO NOT EDIT. Auto-generated by ./tests/dev/generate_roxygen_tests.R.
 
 test_that("analogous to test-roxygen-examples-complete: 14", {
   expect_warning(test_collection("roxygen-examples-complete", "^14-", transformer = style_text), NA)

diff --git a/tests/testthat/test-roxygen-examples-complete-15.R b/tests/testthat/test-roxygen-examples-complete-15.R
@@ -1,4 +1,4 @@
-# NB: DO NOT EDIT. Auto-generated by .dev/gen_roxygen_tests.R.
+# NB: DO NOT EDIT. Auto-generated by ./tests/dev/generate_roxygen_tests.R.
 
 test_that("analogous to test-roxygen-examples-complete: 15", {
   expect_warning(test_collection("roxygen-examples-complete", "^15-", transformer = style_text, scope = "spaces"), NA)

diff --git a/tests/testthat/test-roxygen-examples-complete-16.R b/tests/testthat/test-roxygen-examples-complete-16.R
@@ -1,4 +1,4 @@
-# NB: DO NOT EDIT. Auto-generated by .dev/gen_roxygen_tests.R.
+# NB: DO NOT EDIT. Auto-generated by ./tests/dev/generate_roxygen_tests.R.
 
 test_that("analogous to test-roxygen-examples-complete: 16", {
   expect_warning(test_collection("roxygen-examples-complete", "^16-", transformer = style_text), NA)

diff --git a/tests/testthat/test-roxygen-examples-complete-17.R b/tests/testthat/test-roxygen-examples-complete-17.R
@@ -1,4 +1,4 @@
-# NB: DO NOT EDIT. Auto-generated by .dev/gen_roxygen_tests.R.
+# NB: DO NOT EDIT. Auto-generated by ./tests/dev/generate_roxygen_tests.R.
 
 test_that("analogous to test-roxygen-examples-complete: 17", {
   expect_warning(test_collection("roxygen-examples-complete", "^17-", transformer = style_text), NA)

diff --git a/tests/testthat/test-roxygen-examples-complete-18.R b/tests/testthat/test-roxygen-examples-complete-18.R
@@ -1,4 +1,4 @@
-# NB: DO NOT EDIT. Auto-generated by .dev/gen_roxygen_tests.R.
+# NB: DO NOT EDIT. Auto-generated by ./tests/dev/generate_roxygen_tests.R.
 
 test_that("analogous to test-roxygen-examples-complete: 18", {
   expect_warning(test_collection("roxygen-examples-complete", "^18-", transformer = style_text), NA)

diff --git a/tests/testthat/test-roxygen-examples-complete-19.R b/tests/testthat/test-roxygen-examples-complete-19.R
@@ -1,4 +1,4 @@
-# NB: DO NOT EDIT. Auto-generated by .dev/gen_roxygen_tests.R.
+# NB: DO NOT EDIT. Auto-generated by ./tests/dev/generate_roxygen_tests.R.
 
 test_that("analogous to test-roxygen-examples-complete: 19", {
   expect_warning(test_collection("roxygen-examples-complete", "^19-", transformer = style_text), NA)

diff --git a/tests/testthat/test-roxygen-examples-complete-20.R b/tests/testthat/test-roxygen-examples-complete-20.R
@@ -1,4 +1,4 @@
-# NB: DO NOT EDIT. Auto-generated by .dev/gen_roxygen_tests.R.
+# NB: DO NOT EDIT. Auto-generated by ./tests/dev/generate_roxygen_tests.R.
 
 test_that("analogous to test-roxygen-examples-complete: 20", {
   expect_warning(test_collection("roxygen-examples-complete", "^20-", transformer = style_text), NA)

diff --git a/tests/testthat/test-roxygen-examples-complete-21.R b/tests/testthat/test-roxygen-examples-complete-21.R
@@ -1,4 +1,4 @@
-# NB: DO NOT EDIT. Auto-generated by .dev/gen_roxygen_tests.R.
+# NB: DO NOT EDIT. Auto-generated by ./tests/dev/generate_roxygen_tests.R.
 
 test_that("analogous to test-roxygen-examples-complete: 21", {
   expect_warning(test_collection("roxygen-examples-complete", "^21-", transformer = style_text), NA)

diff --git a/tests/testthat/test-roxygen-examples-complete-22.R b/tests/testthat/test-roxygen-examples-complete-22.R
@@ -1,4 +1,4 @@
-# NB: DO NOT EDIT. Auto-generated by .dev/gen_roxygen_tests.R.
+# NB: DO NOT EDIT. Auto-generated by ./tests/dev/generate_roxygen_tests.R.
 
 test_that("analogous to test-roxygen-examples-complete: 22", {
   expect_warning(test_collection("roxygen-examples-complete", "^22-", transformer = style_text), NA)

diff --git a/tests/testthat/test-roxygen-examples-complete-23.R b/tests/testthat/test-roxygen-examples-complete-23.R
@@ -1,4 +1,4 @@
-# NB: DO NOT EDIT. Auto-generated by .dev/gen_roxygen_tests.R.
+# NB: DO NOT EDIT. Auto-generated by ./tests/dev/generate_roxygen_tests.R.
 
 test_that("analogous to test-roxygen-examples-complete: 23", {
   expect_error(test_collection("roxygen-examples-complete", "^23-", transformer = style_text), "issues/1242")

diff --git a/tests/testthat/test-roxygen-examples-complete-24.R b/tests/testthat/test-roxygen-examples-complete-24.R
@@ -1,4 +1,4 @@
-# NB: DO NOT EDIT. Auto-generated by .dev/gen_roxygen_tests.R.
+# NB: DO NOT EDIT. Auto-generated by ./tests/dev/generate_roxygen_tests.R.
 
 test_that("analogous to test-roxygen-examples-complete: 24", {
   expect_warning(test_collection("roxygen-examples-complete", "^24-", transformer = style_text), NA)

diff --git a/tests/testthat/test-roxygen-examples-complete-25.R b/tests/testthat/test-roxygen-examples-complete-25.R
@@ -1,4 +1,4 @@
-# NB: DO NOT EDIT. Auto-generated by .dev/gen_roxygen_tests.R.
+# NB: DO NOT EDIT. Auto-generated by ./tests/dev/generate_roxygen_tests.R.
 
 test_that("analogous to test-roxygen-examples-complete: 25", {
   expect_warning(test_collection("roxygen-examples-complete", "^25-", transformer = style_text), NA)

diff --git a/tests/testthat/test-roxygen-examples-complete-26.R b/tests/testthat/test-roxygen-examples-complete-26.R
@@ -1,4 +1,4 @@
-# NB: DO NOT EDIT. Auto-generated by .dev/gen_roxygen_tests.R.
+# NB: DO NOT EDIT. Auto-generated by ./tests/dev/generate_roxygen_tests.R.
 
 test_that("analogous to test-roxygen-examples-complete: 26", {
   expect_warning(test_collection("roxygen-examples-complete", "^26-", transformer = style_text), NA)

diff --git a/tests/testthat/test-roxygen-examples-complete-27.R b/tests/testthat/test-roxygen-examples-complete-27.R
@@ -1,4 +1,4 @@
-# NB: DO NOT EDIT. Auto-generated by .dev/gen_roxygen_tests.R.
+# NB: DO NOT EDIT. Auto-generated by ./tests/dev/generate_roxygen_tests.R.
 
 test_that("analogous to test-roxygen-examples-complete: 27", {
   expect_warning(test_collection("roxygen-examples-complete", "^27-", transformer = style_text), NA)

diff --git a/tests/testthat/test-roxygen-examples-complete-28.R b/tests/testthat/test-roxygen-examples-complete-28.R
@@ -1,4 +1,4 @@
-# NB: DO NOT EDIT. Auto-generated by .dev/gen_roxygen_tests.R.
+# NB: DO NOT EDIT. Auto-generated by ./tests/dev/generate_roxygen_tests.R.
 
 test_that("analogous to test-roxygen-examples-complete: 28", {
   expect_warning(test_collection("roxygen-examples-complete", "^28-", transformer = style_text), NA)

diff --git a/tests/testthat/test-roxygen-examples-complete-29.R b/tests/testthat/test-roxygen-examples-complete-29.R
@@ -1,4 +1,4 @@
-# NB: DO NOT EDIT. Auto-generated by .dev/gen_roxygen_tests.R.
+# NB: DO NOT EDIT. Auto-generated by ./tests/dev/generate_roxygen_tests.R.
 
 test_that("analogous to test-roxygen-examples-complete: 29", {
   expect_warning(test_collection("roxygen-examples-complete", "^29-", transformer = style_text), NA)