Skip to content

Commit

Permalink
Make internal status of three helper functions more explicit (#709)
Browse files Browse the repository at this point in the history
* Make internal status of three helper functions more explicit

* Roll micro version, update NEWS [ci skip]
  • Loading branch information
eddelbuettel authored May 23, 2024
1 parent b5e7b9b commit dba1975
Show file tree
Hide file tree
Showing 6 changed files with 23 additions and 6 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Package: tiledb
Type: Package
Version: 0.27.0
Version: 0.27.0.1
Title: Modern Database Engine for Complex Data Based on Multi-Dimensional Arrays
Authors@R: c(person("TileDB, Inc.", role = c("aut", "cph")),
person("Dirk", "Eddelbuettel", email = "[email protected]", role = "cre"))
Expand Down
9 changes: 9 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
# Ongoing development

* This release of the R package builds against [TileDB 2.23.0](https://github.com/TileDB-Inc/TileDB/releases/tag/2.23.0), and has also been tested against earlier releases as well as the development version (#701, #704)

## Improvements

* Three internal and unexported helper functions now document more clearly how they can be called explicitly. (#709)


# tiledb 0.27.0

* This release of the R package builds against [TileDB 2.23.0](https://github.com/TileDB-Inc/TileDB/releases/tag/2.23.0), and has also been tested against earlier releases as well as the development version (#701, #704)
Expand Down
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.

0 comments on commit dba1975

Please sign in to comment.