Skip to content

Commit

Permalink
Documentation fixes (#783)
Browse files Browse the repository at this point in the history
* Micro edit: be encryption -> be encrypted

* Consistent use of 'TileDB Schema' argument description

* Minor edits

* Micro typo fixes

* Added return value on some methods

* Consistent use of 'tiledb_dim' argument description

* Minor doc edits and fixes

* Fix typo and spelling

* Update R/Array.R

Co-authored-by: John Kerl <[email protected]>

* Roxygenise [ci skip]

* Doc fix: add missing bare infinitive

---------

Co-authored-by: John Kerl <[email protected]>
  • Loading branch information
cgiachalis and johnkerl authored Jan 11, 2025
1 parent e952a9b commit e07151c
Show file tree
Hide file tree
Showing 47 changed files with 182 additions and 152 deletions.
20 changes: 10 additions & 10 deletions R/Array.R
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
#' @param uri URI specifying path to create the TileDB array object
#' @param schema tiledb_array_schema object
#' @param encryption_key optional A character value with an AES-256 encryption key
#' in case the array should be encryption.
#' in case the array should be encrypted.
#'
#' @examples
#' \dontshow{
Expand Down Expand Up @@ -181,9 +181,9 @@ tiledb_array_is_heterogeneous <- function(arr) {
##' @return A boolean indicating success
##' @export
tiledb_array_delete_fragments <- function(
arr,
ts_start,
ts_end,
arr,
ts_start,
ts_end,
ctx = tiledb_get_context()
) {
stopifnot(
Expand All @@ -197,15 +197,15 @@ tiledb_array_delete_fragments <- function(

##' Delete fragments written given by their URIs
##'
##' @param arr A TileDB Array object as for example returned by
##' @param arr A TileDB Array object as for example returned by
##' \code{tiledb_array()}
##' @param fragments A character vector with fragment URIs
##' @param ctx A tiledb_ctx object (optional)
##' @return A boolean indicating success
##' @export
tiledb_array_delete_fragments_list <- function(
arr,
fragments,
arr,
fragments,
ctx = tiledb_get_context()
) {
stopifnot(
Expand Down Expand Up @@ -247,7 +247,7 @@ tiledb_array_has_enumeration <- function(arr) {
##' @return The value of the aggregation
##' @export
tiledb_array_apply_aggregate <- function(
array,
array,
attrname,
operation = c("Count", "NullCount", "Min", "Max", "Mean", "Sum"),
nullable = TRUE
Expand Down Expand Up @@ -283,8 +283,8 @@ tiledb_array_apply_aggregate <- function(
##' @return Nothing is returned as the function is invoked for its side effect
##' @export
tiledb_array_upgrade_version <- function(
array,
config = NULL,
array,
config = NULL,
ctx = tiledb_get_context()
) {
stopifnot(
Expand Down
Loading

0 comments on commit e07151c

Please sign in to comment.