From e9e242f38f0554a31c5941400b40d2e03a20e12f Mon Sep 17 00:00:00 2001 From: Alex Peters <80283343+alexpeters1208@users.noreply.github.com> Date: Tue, 19 Sep 2023 13:42:57 -0500 Subject: [PATCH] Modify Roxygen directives and NAMESPACE header to ensure devtools::document() produces consistent results (#4518) * Get rid of autogenerate directive in NAMESPACE * Rewrite roxygen headers to ensure devtools::document() produces consistent results --- R/rdeephaven/NAMESPACE | 2 -- R/rdeephaven/R/client_wrapper.R | 5 +++++ R/rdeephaven/R/table_handle_wrapper.R | 6 ++++++ 3 files changed, 11 insertions(+), 2 deletions(-) diff --git a/R/rdeephaven/NAMESPACE b/R/rdeephaven/NAMESPACE index 634a18faaf7..1b203dfa28c 100644 --- a/R/rdeephaven/NAMESPACE +++ b/R/rdeephaven/NAMESPACE @@ -1,5 +1,3 @@ -# Generated by roxygen2: do not edit by hand - S3method(as.data.frame,TableHandle) S3method(as_arrow_table,TableHandle) S3method(as_record_batch_reader,TableHandle) diff --git a/R/rdeephaven/R/client_wrapper.R b/R/rdeephaven/R/client_wrapper.R index 6ce3dee5346..bf3510707e6 100644 --- a/R/rdeephaven/R/client_wrapper.R +++ b/R/rdeephaven/R/client_wrapper.R @@ -1,6 +1,11 @@ +#' @title The Deephaven Client #' @description #' A Client is the entry point for interacting with the Deephaven server. It is used to create new tables, #' import data to and export data from the server, and run queries on the server. +#' +#' @usage NULL +#' @format NULL +#' @docType class #' @export Client <- R6Class("Client", cloneable = FALSE, diff --git a/R/rdeephaven/R/table_handle_wrapper.R b/R/rdeephaven/R/table_handle_wrapper.R index d538665bfbc..6a39410d94e 100644 --- a/R/rdeephaven/R/table_handle_wrapper.R +++ b/R/rdeephaven/R/table_handle_wrapper.R @@ -1,7 +1,13 @@ +#' @title Deephaven TableHandles #' @description #' A TableHandle holds a reference to a Deephaven Table on the server, and provides methods for operating on that table. #' Note that TableHandles should not be instantiated directly by user code, but rather by server calls accessible from #' the `Client` class. See `?Client` for more information. +#' +#' @usage NULL +#' @format NULL +#' @docType class +#' @export TableHandle <- R6Class("TableHandle", cloneable = FALSE, public = list(