Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Modify Roxygen directives and NAMESPACE header to ensure devtools::document() produces consistent results #4518

Merged
merged 2 commits into from
Sep 19, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions R/rdeephaven/NAMESPACE
Original file line number Diff line number Diff line change
@@ -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)
Expand Down
5 changes: 5 additions & 0 deletions R/rdeephaven/R/client_wrapper.R
Original file line number Diff line number Diff line change
@@ -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,
Expand Down
6 changes: 6 additions & 0 deletions R/rdeephaven/R/table_handle_wrapper.R
Original file line number Diff line number Diff line change
@@ -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(
Expand Down
Loading