Clarify use of .rownames in column definitions

glin · Jul 22, 2024 · 363068c · 363068c
1 parent 09c24a7
commit 363068c
Show file tree

Hide file tree

Showing 5 changed files with 6 additions and 5 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -52,5 +52,5 @@ Suggests:
     V8
 Encoding: UTF-8
 Roxygen: list(markdown = TRUE)
-RoxygenNote: 7.2.3
+RoxygenNote: 7.3.2
 Config/testthat/edition: 3
diff --git a/R/reactable.R b/R/reactable.R
@@ -22,7 +22,8 @@
 #' @param columnGroups List of column group definitions. See [colGroup()].
 #' @param rownames Show row names? Defaults to `TRUE` if the data has row names.
 #'
-#'   To customize the row names column, use `".rownames"` as the column name.
+#'   To customize the row names column, add a column definition using `".rownames"`
+#'   as the column name.
 #'
 #'   Cells in the row names column are automatically marked up as row headers
 #'   for assistive technologies.

diff --git a/man/reactable-package.Rd b/man/reactable-package.Rd
diff --git a/man/reactable.Rd b/man/reactable.Rd
diff --git a/vignettes/examples.Rmd b/vignettes/examples.Rmd
@@ -1731,7 +1731,7 @@ reactable(
 ### Row names
 
 Row names are shown by default if present. You can customize the row names column
-using `".rownames"` as the column name:
+by adding a column definition using `".rownames"` as the column name:
 
 ```{r}
 reactable(