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

Make internal status of three helper functions more explicit #709

Merged
merged 2 commits into from
May 23, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
9 changes: 7 additions & 2 deletions R/ArraySchema.R
Original file line number Diff line number Diff line change
Expand Up @@ -530,7 +530,8 @@ tiledb_schema_get_types <- function(sch) {

##' Get Dimension or Attribute Status
##'
##' Note that this function is an unexported internal function.
##' Note that this function is an unexported internal function that can be called
##' using the colons as in \code{tiledb:::tiledb_schema_get_dim_attr_status(sch)}.
##'
##' @param sch A TileDB Schema object
##' @return An integer vector where each element corresponds to a schema entry,
Expand All @@ -545,7 +546,8 @@ tiledb_schema_get_dim_attr_status <- function(sch) {

##' Get Dimension or Attribute Status
##'
##' Note that this function is an unexported internal function.
##' Note that this function is an unexported internal function that can be called
##' using the colons as in \code{tiledb:::tiledb_schema_get_enumeration_status(sch)}.
##'
##' @param sch A TileDB Schema object
##' @return An integer vector where each element corresponds to a schema entry,
Expand Down Expand Up @@ -863,6 +865,9 @@ tiledb_schema_object <- function(array) {

#' Describe a TileDB array schema via code to create it
#'
#' Note that this function is an unexported internal function that can be called
#' using the colons as in \code{tiledb:::describe(arr)}.
#'
#' @param arr A TileDB Array object
#' @return Nothing is returned as the function is invoked for the side effect
#' of printing the schema via a sequence of R instructions to re-create it.
Expand Down
3 changes: 2 additions & 1 deletion man/describe.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion man/tiledb_schema_get_dim_attr_status.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion man/tiledb_schema_get_enumeration_status.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading