Redo pkgdown index. Remove docs for wb_hyperlink(). It was not expo…

…rted anyway.
JanMarvin · Aug 23, 2023 · 2149a15 · 2149a15
1 parent 5d7668f
commit 2149a15
Show file tree

Hide file tree

Showing 9 changed files with 22 additions and 21 deletions.
diff --git a/NAMESPACE b/NAMESPACE
@@ -39,7 +39,6 @@ export(remove_comment)
 export(rowcol_to_dims)
 export(styles_on_sheet)
 export(temp_xlsx)
-export(wbChartSheet)
 export(wbWorkbook)
 export(wb_add_border)
 export(wb_add_cell_style)

diff --git a/NEWS.md b/NEWS.md
@@ -15,7 +15,7 @@
 
 ## Breaking changes
 
-* no longer exporting `wb_get_sheet_name()`
+* no longer exporting `wb_get_sheet_name()`, `wbChartSheet` and `wb_hyperlink()`
 * deprecating `delete_data()` and minor improvements to `wb_clean_sheet()`
 * removing `wb_get_worksheet()`, `wb_ws()`. These never worked as expected.
 * `create_comment()` has been renamed `wb_comment()`.  [758, @olivroy](https://github.com/JanMarvin/openxlsx2/pull/758) The default arguments however are changed:

diff --git a/R/class-chart-sheet.R b/R/class-chart-sheet.R
@@ -4,7 +4,6 @@
 #' @description
 #' A chart sheet
 #'
-#' @export
 wbChartSheet <- R6::R6Class(
   "wbChartSheet",
 

diff --git a/R/class-hyperlink.R b/R/class-hyperlink.R
@@ -72,7 +72,7 @@ wbHyperlink <- R6::R6Class(
 )
 
 #' Create a new hyperlink object
-#' @rdname Hyperlink
+#' @noRd
 wb_hyperlink <- function() {
   wbHyperlink$new(ref = character(), target = character(), location = character())
 }

diff --git a/R/dates.R b/R/dates.R
@@ -178,8 +178,13 @@ convert_to_excel_date <- function(df, date1904 = FALSE) {
   df
 }
 
+#' Convert to Excel data
+#'
+#' Use [convert_to_excel_date()] in new code
+#' @usage NULL
+#' @inheritParams convert_to_excel_date
+#' @keywords internal
 #' @export
-#' @rdname convert_to_excel_date
 convertToExcelDate <- function(df, date1904 = FALSE) {
   .Deprecated(old = "convertToExcelDate", new = "convert_to_excel_date", package = "openxlsx2")
   convert_to_excel_date(df = df, date1904 = date1904)

diff --git a/_pkgdown.yml b/_pkgdown.yml
@@ -75,7 +75,6 @@ reference:
     These functions help you interact with chartsheets. They invisibly return the
     wbWorkbook object.  They help interact with the mschart package.
   contents:
-  - wbChartSheet
   - wb_data
   - wb_add_chartsheet
   - wb_add_mschart
@@ -93,7 +92,6 @@ reference:
   - wb_dims
   - wb_color
   - wb_comment
-  - wb_hyperlink
   - starts_with("create_")
 
 

diff --git a/man/Hyperlink.Rd b/man/Hyperlink.Rd
diff --git a/man/convertToExcelDate.Rd b/man/convertToExcelDate.Rd
diff --git a/man/convert_to_excel_date.Rd b/man/convert_to_excel_date.Rd