From 22d398d5774595a843003b085ea1dd936c780a4f Mon Sep 17 00:00:00 2001
From: olivroy <olivierroy71@hotmail.com>
Date: Tue, 22 Aug 2023 00:37:24 -0400
Subject: [PATCH] Unify function titles

---
 R/class-workbook-wrappers.R    | 36 +++++++++++++++++-----------------
 _pkgdown.yml                   |  2 +-
 man/wb_add_chart_xml.Rd        |  4 ++--
 man/wb_clone_sheet_style.Rd    |  4 ++--
 man/wb_clone_worksheet.Rd      |  2 +-
 man/wb_creators.Rd             |  2 +-
 man/wb_grouping.Rd             |  6 +++---
 man/wb_page_setup.Rd           |  2 +-
 man/wb_set_grid_lines.Rd       |  4 ++--
 man/wb_set_last_modified_by.Rd |  2 +-
 man/wb_sheet_visibility.Rd     |  2 +-
 man/wb_update_table.Rd         | 10 +++++-----
 12 files changed, 38 insertions(+), 38 deletions(-)

diff --git a/R/class-workbook-wrappers.R b/R/class-workbook-wrappers.R
index 17dbc0bfa..4fa5be9e8 100644
--- a/R/class-workbook-wrappers.R
+++ b/R/class-workbook-wrappers.R
@@ -419,13 +419,13 @@ wb_add_formula <- function(
   )
 }
 
-#' Update a data table
+#' Update a data table position in a worksheet
 #'
 #' Update the position of a data table, possibly written using [wb_add_data_table()]
-#' @param wb workbook
-#' @param sheet a worksheet
-#' @param dims cell range used for new data table.
-#' @param tabname a tablename
+#' @param wb A workbook
+#' @param sheet A worksheet
+#' @param dims Cell range used for new data table.
+#' @param tabname A table name
 #'
 #' @details
 #' Be aware that this function does not alter any filter.
@@ -722,7 +722,7 @@ wb_add_worksheet <- function(
 }
 
 
-#' Clone a worksheet in a workbook
+#' Create copies of a worksheet within a workbook
 #'
 #' @description
 #' Create a copy of a worksheet in the same `wbWorkbook` object.
@@ -1325,7 +1325,7 @@ wb_set_header_footer <- function(
 
 
 
-#' Set page margins, orientation and print scaling
+#' Set page margins, orientation and print scaling of a worksheet
 #'
 #' Set page margins, orientation and print scaling.
 #' @param wb A workbook object
@@ -1611,9 +1611,9 @@ wb_protect <- function(
 
 # grid lines --------------------------------------------------------------
 
-#' Set worksheet gridlines to show or hide.
+#' Modify grid lines visibility in a worksheet
 #'
-#' Set worksheet gridlines to show or hide.
+#' Set worksheet grid lines to show or hide.
 #' You can also add / remove grid lines when creating a worksheeet with
 #' [`wb_add_worksheet(grid_lines = FALSE)`][wb_add_worksheet()]
 #'
@@ -1962,7 +1962,7 @@ wb_add_data_validation <- function(
 
 # visibility --------------------------------------------------------------
 
-#' Get/set worksheet visible state
+#' Get/set worksheet visible state in a workbook
 #'
 #' Get and set worksheet visible state. This allows to hide worksheets from the workbook.
 #'
@@ -2089,13 +2089,13 @@ wb_remove_tables <- function(wb, sheet = current_sheet(), table, remove_data = T
 
 # grouping ----------------------------------------------------------------
 
-#' Group Rows and Columns
+#' Group rows and columns in a worksheet
 #'
 #' Group a selection of rows or cols
 #'
-#' @details If row was previously hidden, it will now be shown
+#' @details If row was previously hidden, it will now be shown.
 #'
-#' @param wb A [wbWorkbook] object
+#' @param wb A `wbWorkbook` object
 #' @param sheet A name or index of a worksheet
 #' @param rows,cols Indices of rows and columns to group
 #' @param collapsed If `TRUE` the grouped columns are collapsed
@@ -2192,7 +2192,7 @@ wb_ungroup_rows <- function(wb, sheet = current_sheet(), rows) {
 
 # creators ----------------------------------------------------------------
 
-#' Workbook creators
+#' Modify creators of a workbook
 #'
 #' Modify and get workbook creators
 #'
@@ -2289,7 +2289,7 @@ wb_get_sheet_names <- function(wb, escape = FALSE) {
 
 # others? -----------------------------------------------------------------
 
-#' Add another author to the meta data of the file.
+#' Modify author in the metadata of a workbook
 #'
 #' Just a wrapper of `wb$set_last_modified_by()`
 #'
@@ -2362,7 +2362,7 @@ wb_add_image <- function(
 }
 
 
-#' Add a chart XML to a workbook
+#' Add a chart XML to a worksheet
 #'
 #' @param wb a workbook
 #' @param sheet the sheet on which the graph will appear
@@ -3272,13 +3272,13 @@ wb_add_conditional_formatting <- function(
   )
 }
 
-#' clone sheets style
+#' Apply styling from a sheet to another within a workbook
 #'
 #' This function can be used to apply styling from a cell range, and apply it
 #' to another cell range.
 #' @param wb A workbook
 #' @param from sheet we select the style from
-#' @param to sheet we apply the style from
+#' @param to sheet to apply the style to
 #' @export
 wb_clone_sheet_style <- function(wb, from = current_sheet(), to) {
   assert_workbook(wb)
diff --git a/_pkgdown.yml b/_pkgdown.yml
index 071d2d823..1fb5579ed 100644
--- a/_pkgdown.yml
+++ b/_pkgdown.yml
@@ -60,12 +60,12 @@ reference:
   - wb_set_last_modified_by
   - wb_creators
   - wb_order
+  - wb_sheet_names
   - wb_remove_worksheet
   - wb_active_sheet
   - wb_sheet_visibility
   - wb_set_bookview
   - wb_protect
-  - wb_sheet_names
   - wb_get_tables
   - wb_remove_tables
   - wb_get_named_regions
diff --git a/man/wb_add_chart_xml.Rd b/man/wb_add_chart_xml.Rd
index eac6dd593..66fd127df 100644
--- a/man/wb_add_chart_xml.Rd
+++ b/man/wb_add_chart_xml.Rd
@@ -2,7 +2,7 @@
 % Please edit documentation in R/class-workbook-wrappers.R
 \name{wb_add_chart_xml}
 \alias{wb_add_chart_xml}
-\title{Add a chart XML to a workbook}
+\title{Add a chart XML to a worksheet}
 \usage{
 wb_add_chart_xml(
   wb,
@@ -28,7 +28,7 @@ wb_add_chart_xml(
 \item{...}{additional arguments}
 }
 \description{
-Add a chart XML to a workbook
+Add a chart XML to a worksheet
 }
 \seealso{
 \code{\link[=wb_add_drawing]{wb_add_drawing()}} \code{\link[=wb_add_image]{wb_add_image()}} \code{\link[=wb_add_mschart]{wb_add_mschart()}} \code{\link[=wb_add_plot]{wb_add_plot()}}
diff --git a/man/wb_clone_sheet_style.Rd b/man/wb_clone_sheet_style.Rd
index f0b8a2413..2627258e9 100644
--- a/man/wb_clone_sheet_style.Rd
+++ b/man/wb_clone_sheet_style.Rd
@@ -2,7 +2,7 @@
 % Please edit documentation in R/class-workbook-wrappers.R
 \name{wb_clone_sheet_style}
 \alias{wb_clone_sheet_style}
-\title{clone sheets style}
+\title{Apply styling from a sheet to another within a workbook}
 \usage{
 wb_clone_sheet_style(wb, from = current_sheet(), to)
 }
@@ -11,7 +11,7 @@ wb_clone_sheet_style(wb, from = current_sheet(), to)
 
 \item{from}{sheet we select the style from}
 
-\item{to}{sheet we apply the style from}
+\item{to}{sheet to apply the style to}
 }
 \description{
 This function can be used to apply styling from a cell range, and apply it
diff --git a/man/wb_clone_worksheet.Rd b/man/wb_clone_worksheet.Rd
index 62179a027..177d55422 100644
--- a/man/wb_clone_worksheet.Rd
+++ b/man/wb_clone_worksheet.Rd
@@ -2,7 +2,7 @@
 % Please edit documentation in R/class-workbook-wrappers.R
 \name{wb_clone_worksheet}
 \alias{wb_clone_worksheet}
-\title{Clone a worksheet in a workbook}
+\title{Create copies of a worksheet within a workbook}
 \usage{
 wb_clone_worksheet(wb, old = current_sheet(), new = next_sheet())
 }
diff --git a/man/wb_creators.Rd b/man/wb_creators.Rd
index 1fea73080..35972c32a 100644
--- a/man/wb_creators.Rd
+++ b/man/wb_creators.Rd
@@ -6,7 +6,7 @@
 \alias{wb_set_creators}
 \alias{wb_remove_creators}
 \alias{wb_get_creators}
-\title{Workbook creators}
+\title{Modify creators of a workbook}
 \usage{
 wb_add_creators(wb, creators)
 
diff --git a/man/wb_grouping.Rd b/man/wb_grouping.Rd
index ddfb9cfc5..becb4b809 100644
--- a/man/wb_grouping.Rd
+++ b/man/wb_grouping.Rd
@@ -6,7 +6,7 @@
 \alias{wb_ungroup_cols}
 \alias{wb_group_rows}
 \alias{wb_ungroup_rows}
-\title{Group Rows and Columns}
+\title{Group rows and columns in a worksheet}
 \usage{
 wb_group_cols(
   wb,
@@ -29,7 +29,7 @@ wb_group_rows(
 wb_ungroup_rows(wb, sheet = current_sheet(), rows)
 }
 \arguments{
-\item{wb}{A \link{wbWorkbook} object}
+\item{wb}{A \code{wbWorkbook} object}
 
 \item{sheet}{A name or index of a worksheet}
 
@@ -43,7 +43,7 @@ wb_ungroup_rows(wb, sheet = current_sheet(), rows)
 Group a selection of rows or cols
 }
 \details{
-If row was previously hidden, it will now be shown
+If row was previously hidden, it will now be shown.
 }
 \examples{
 # create matrix
diff --git a/man/wb_page_setup.Rd b/man/wb_page_setup.Rd
index f003907c9..623d400ac 100644
--- a/man/wb_page_setup.Rd
+++ b/man/wb_page_setup.Rd
@@ -2,7 +2,7 @@
 % Please edit documentation in R/class-workbook-wrappers.R
 \name{wb_page_setup}
 \alias{wb_page_setup}
-\title{Set page margins, orientation and print scaling}
+\title{Set page margins, orientation and print scaling of a worksheet}
 \usage{
 wb_page_setup(
   wb,
diff --git a/man/wb_set_grid_lines.Rd b/man/wb_set_grid_lines.Rd
index 07affbb7d..c4b2795d0 100644
--- a/man/wb_set_grid_lines.Rd
+++ b/man/wb_set_grid_lines.Rd
@@ -3,7 +3,7 @@
 \name{wb_set_grid_lines}
 \alias{wb_set_grid_lines}
 \alias{wb_grid_lines}
-\title{Set worksheet gridlines to show or hide.}
+\title{Modify grid lines visibility in a worksheet}
 \usage{
 wb_set_grid_lines(wb, sheet = current_sheet(), show = FALSE, print = show)
 
@@ -19,7 +19,7 @@ wb_grid_lines(wb, sheet = current_sheet(), show = FALSE, print = show)
 \item{print}{A logical. If \code{FALSE}, grid lines are not printed.}
 }
 \description{
-Set worksheet gridlines to show or hide.
+Set worksheet grid lines to show or hide.
 You can also add / remove grid lines when creating a worksheeet with
 \code{\link[=wb_add_worksheet]{wb_add_worksheet(grid_lines = FALSE)}}
 }
diff --git a/man/wb_set_last_modified_by.Rd b/man/wb_set_last_modified_by.Rd
index fed89ec06..7b3c74678 100644
--- a/man/wb_set_last_modified_by.Rd
+++ b/man/wb_set_last_modified_by.Rd
@@ -2,7 +2,7 @@
 % Please edit documentation in R/class-workbook-wrappers.R
 \name{wb_set_last_modified_by}
 \alias{wb_set_last_modified_by}
-\title{Add another author to the meta data of the file.}
+\title{Modify author in the metadata of a workbook}
 \usage{
 wb_set_last_modified_by(wb, name, ...)
 }
diff --git a/man/wb_sheet_visibility.Rd b/man/wb_sheet_visibility.Rd
index c377f4e35..00f78292a 100644
--- a/man/wb_sheet_visibility.Rd
+++ b/man/wb_sheet_visibility.Rd
@@ -4,7 +4,7 @@
 \alias{wb_sheet_visibility}
 \alias{wb_get_sheet_visibility}
 \alias{wb_set_sheet_visibility}
-\title{Get/set worksheet visible state}
+\title{Get/set worksheet visible state in a workbook}
 \usage{
 wb_get_sheet_visibility(wb)
 
diff --git a/man/wb_update_table.Rd b/man/wb_update_table.Rd
index 34d0c4bb0..49351a26d 100644
--- a/man/wb_update_table.Rd
+++ b/man/wb_update_table.Rd
@@ -2,18 +2,18 @@
 % Please edit documentation in R/class-workbook-wrappers.R
 \name{wb_update_table}
 \alias{wb_update_table}
-\title{Update a data table}
+\title{Update a data table position in a worksheet}
 \usage{
 wb_update_table(wb, sheet = current_sheet(), dims = "A1", tabname)
 }
 \arguments{
-\item{wb}{workbook}
+\item{wb}{A workbook}
 
-\item{sheet}{a worksheet}
+\item{sheet}{A worksheet}
 
-\item{dims}{cell range used for new data table.}
+\item{dims}{Cell range used for new data table.}
 
-\item{tabname}{a tablename}
+\item{tabname}{A table name}
 }
 \description{
 Update the position of a data table, possibly written using \code{\link[=wb_add_data_table]{wb_add_data_table()}}