Update test comments for labels

Author: jeffreyad

tests/testthat/test-labels.R

@@ -58,7 +58,8 @@ mc <- suppressWarnings(
   )
 )
 
-test_that("Check that add_labels applies labels properly", {
+# add_labels() tests ----
+test_that("add_labels applies labels properly", {
   x <- mtcars %>%
     add_labels(
       mpg = "Miles Per Gallon",
@@ -69,14 +70,15 @@ test_that("Check that add_labels applies labels properly", {
   expect_equal(attr(x$cyl, "label"), "Cylinders")
 })
 
-test_that("Check that add_labels errors properly", {
+test_that("add_labels errors on invalid input", {
   expect_error(add_labels(TRUE, x = "label"))
   expect_error(add_labels(mtcars, "label"))
   expect_error(add_labels(mtcars, bad = "label"))
   expect_error(add_labels(mtcars, mpg = 1))
 })
 
-test_that("set_variable_labels applies labels properly", {
+# set_variable_labels() tests ----
+test_that("set_variable_labels applies labels from metacore properly", {
   # Load in the metacore test object and example data
   suppressMessages(
     mc <- metacore::spec_to_metacore(metacore::metacore_example("p21_mock.xlsx"), quiet = TRUE) %>%
@@ -94,27 +96,27 @@ test_that("set_variable_labels applies labels properly", {
   expect_equal(labs, mc$var_spec$label)
 })
 
-test_that("set_variable_labels raises warnings properly", {
+test_that("set_variable_labels warns on variable mismatches", {
   # This is metadata for the dplyr::starwars dataset
   mc <- suppressWarnings(
     suppressMessages(
       metacore::metacore(ds_spec, ds_vars, var_spec, value_spec, derivations, code_id)
     )
   ) %>% select_dataset("Starwars", quiet = TRUE)
 
+  # Variables in data not in metadata
   starwars_short2 <- starwars_short
   starwars_short2$new_var <- ""
-
-  # Variables in data not in metadata
   expect_warning(set_variable_labels(starwars_short2, mc))
 
-  mc <- suppressWarnings(
+  # Variables in metadata not in data
+  mc_subset <- suppressWarnings(
     suppressMessages(
       metacore::metacore(ds_spec, ds_vars[1:4, ], var_spec[1:4, ], value_spec, derivations, code_id) %>%
         metacore::select_dataset("Starwars", quiet = TRUE)
     )
   )
-  expect_warning(set_variable_labels(starwars_short, mc))
+  expect_warning(set_variable_labels(starwars_short, mc_subset))
 })
 
 test_that("set_variable_labels respects verbose parameter", {
@@ -151,6 +153,7 @@ test_that("set_variable_labels respects verbose parameter", {
   )
 })
 
+# remove_labels() tests ----
 test_that("remove_labels removes labels properly", {
   # Add labels first
   x <- mtcars |>