Merge pull request #990 from rstudio/family-names

Adjust family names to fit with .Rd templating
rstudio · Jul 22, 2022 · faf9f40 · faf9f40
2 parents 088b6f4 + 9f5b8c5
commit faf9f40
Show file tree

Hide file tree

Showing 112 changed files with 290 additions and 290 deletions.
diff --git a/R/data_color.R b/R/data_color.R
@@ -126,7 +126,7 @@
 #' `r man_get_image_tag(file = "man_data_color_2.png")`
 #' }}
 #'
-#' @family Format Data
+#' @family data formatting functions
 #' @section Function ID:
 #' 3-21
 #'

diff --git a/R/datasets.R b/R/datasets.R
@@ -27,7 +27,7 @@
 #' dplyr::glimpse(countrypops)
 #' ```
 #'
-#' @family Datasets
+#' @family datasets
 #' @section Function ID:
 #' 11-1
 #'
@@ -78,7 +78,7 @@
 #' dplyr::glimpse(sza)
 #' ```
 #'
-#' @family Datasets
+#' @family datasets
 #' @section Function ID:
 #' 11-2
 #'
@@ -133,7 +133,7 @@
 #' dplyr::glimpse(gtcars)
 #' ```
 #'
-#' @family Datasets
+#' @family datasets
 #' @section Function ID:
 #' 11-3
 #'
@@ -163,7 +163,7 @@
 #' dplyr::glimpse(sp500)
 #' ```
 #'
-#' @family Datasets
+#' @family datasets
 #' @section Function ID:
 #' 11-4
 #'
@@ -294,7 +294,7 @@
 #' dplyr::glimpse(pizzaplace)
 #' ```
 #'
-#' @family Datasets
+#' @family datasets
 #' @section Function ID:
 #' 11-5
 #'
@@ -338,7 +338,7 @@
 #' exibble
 #' ```
 #'
-#' @family Datasets
+#' @family datasets
 #' @section Function ID:
 #' 11-6
 #'

diff --git a/R/export.R b/R/export.R
@@ -107,7 +107,7 @@
 #' tab_1 %>% gtsave("tab_1.docx")
 #' ```
 #'
-#' @family Export Functions
+#' @family table export functions
 #' @section Function ID:
 #' 13-1
 #'
@@ -378,7 +378,7 @@ gtsave_filename <- function(path, filename) {
 #' It has only the `<table>...</table>` part so it's not a complete HTML
 #' document but rather an HTML fragment.
 #'
-#' @family Export Functions
+#' @family table export functions
 #' @section Function ID:
 #' 13-2
 #'
@@ -443,7 +443,7 @@ as_raw_html <- function(
 #' Markdown documents that are knit to PDF. We can use `as.character()` to get
 #' just the LaTeX code as a single-element vector.
 #'
-#' @family Export Functions
+#' @family table export functions
 #' @section Function ID:
 #' 13-3
 #'
@@ -527,7 +527,7 @@ as_latex <- function(data) {
 #'   as_rtf()
 #' ```
 #'
-#' @family Export Functions
+#' @family table export functions
 #' @section Function ID:
 #' 13-4
 #'
@@ -631,7 +631,7 @@ as_rtf <- function(data) {
 #'   ) %>%
 #'   as_word()
 #'
-#' @family Export Functions
+#' @family table export functions
 #' @section Function ID:
 #' 13-5
 #'
@@ -832,7 +832,7 @@ as_word_tbl_body <- function(
 #' `r man_get_image_tag(file = "man_extract_summary_1.png")`
 #' }}
 #'
-#' @family Export Functions
+#' @family table export functions
 #' @section Function ID:
 #' 13-6
 #'

diff --git a/R/format_data.R b/R/format_data.R
@@ -154,7 +154,7 @@
 #' `r man_get_image_tag(file = "man_fmt_number_2.png")`
 #' }}
 #'
-#' @family Format Data
+#' @family data formatting functions
 #' @section Function ID:
 #' 3-1
 #'
@@ -349,7 +349,7 @@ fmt_number <- function(
 #' `r man_get_image_tag(file = "man_fmt_integer_1.png")`
 #' }}
 #'
-#' @family Format Data
+#' @family data formatting functions
 #' @section Function ID:
 #' 3-2
 #'
@@ -449,7 +449,7 @@ fmt_integer <- function(
 #' `r man_get_image_tag(file = "man_fmt_scientific_1.png")`
 #' }}
 #'
-#' @family Format Data
+#' @family data formatting functions
 #' @section Function ID:
 #' 3-3
 #'
@@ -633,7 +633,7 @@ fmt_scientific <- function(
 #' `r man_get_image_tag(file = "man_fmt_engineering_1.png")`
 #' }}
 #'
-#' @family Format Data
+#' @family data formatting functions
 #' @section Function ID:
 #' 3-4
 #'
@@ -992,7 +992,7 @@ fmt_symbol <- function(
 #' `r man_get_image_tag(file = "man_fmt_percent_1.png")`
 #' }}
 #'
-#' @family Format Data
+#' @family data formatting functions
 #' @section Function ID:
 #' 3-5
 #'
@@ -1150,7 +1150,7 @@ fmt_percent <- function(
 #' `r man_get_image_tag(file = "man_fmt_partsper_1.png")`
 #' }}
 #'
-#' @family Format Data
+#' @family data formatting functions
 #' @section Function ID:
 #' 3-6
 #'
@@ -1387,7 +1387,7 @@ fmt_partsper <- function(
 #' `r man_get_image_tag(file = "man_fmt_fraction_1.png")`
 #' }}
 #'
-#' @family Format Data
+#' @family data formatting functions
 #' @section Function ID:
 #' 3-7
 #'
@@ -1823,7 +1823,7 @@ round_gt <- function(x, digits = 0) {
 #' `r man_get_image_tag(file = "man_fmt_currency_2.png")`
 #' }}
 #'
-#' @family Format Data
+#' @family data formatting functions
 #' @section Function ID:
 #' 3-8
 #'
@@ -1985,7 +1985,7 @@ fmt_currency <- function(
 #' `r man_get_image_tag(file = "man_fmt_bytes_2.png")`
 #' }}
 #'
-#' @family Format Data
+#' @family data formatting functions
 #' @section Function ID:
 #' 3-9
 #'
@@ -2182,7 +2182,7 @@ fmt_bytes <- function(
 #' `r man_get_image_tag(file = "man_fmt_date_2.png")`
 #' }}
 #'
-#' @family Format Data
+#' @family data formatting functions
 #' @section Function ID:
 #' 3-10
 #'
@@ -2338,7 +2338,7 @@ fmt_date <- function(
 #' `r man_get_image_tag(file = "man_fmt_time_2.png")`
 #' }}
 #'
-#' @family Format Data
+#' @family data formatting functions
 #' @section Function ID:
 #' 3-11
 #'
@@ -2559,7 +2559,7 @@ fmt_time <- function(
 #' `r man_get_image_tag(file = "man_fmt_datetime_1.png")`
 #' }}
 #'
-#' @family Format Data
+#' @family data formatting functions
 #' @section Function ID:
 #' 3-12
 #'
@@ -2795,7 +2795,7 @@ fmt_datetime <- function(
 #' `r man_get_image_tag(file = "man_fmt_duration_1.png")`
 #' }}
 #'
-#' @family Format Data
+#' @family data formatting functions
 #' @section Function ID:
 #' 3-13
 #'
@@ -3513,7 +3513,7 @@ extract_duration_pattern <- function(
 #' `r man_get_image_tag(file = "man_fmt_markdown_1.png")`
 #' }}
 #'
-#' @family Format Data
+#' @family data formatting functions
 #' @section Function ID:
 #' 3-14
 #'
@@ -3607,7 +3607,7 @@ fmt_markdown <- function(
 #' `r man_get_image_tag(file = "man_fmt_passthrough_1.png")`
 #' }}
 #'
-#' @family Format Data
+#' @family data formatting functions
 #' @section Function ID:
 #' 3-15
 #'
@@ -3763,7 +3763,7 @@ fmt_passthrough <- function(
 #' `r man_get_image_tag(file = "man_fmt_1.png")`
 #' }}
 #'
-#' @family Format Data
+#' @family data formatting functions
 #' @section Function ID:
 #' 3-16
 #'

diff --git a/R/gt.R b/R/gt.R
@@ -93,7 +93,7 @@
 #' `r man_get_image_tag(file = "man_gt_2.png")`
 #' }}
 #'
-#' @family Create Table
+#' @family table creation functions
 #' @section Function ID:
 #' 1-1
 #'

diff --git a/R/gt_preview.R b/R/gt_preview.R
@@ -42,7 +42,7 @@
 #' `r man_get_image_tag(file = "man_gt_preview_1.png")`
 #' }}
 #'
-#' @family Create Table
+#' @family table creation functions
 #' @section Function ID:
 #' 1-2
 #'