Skip to content

Commit e07151c

Browse files
cgiachalisjohnkerl
andauthored
Documentation fixes (#783)
* 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]>
1 parent e952a9b commit e07151c

File tree

47 files changed

+182
-152
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

47 files changed

+182
-152
lines changed

R/Array.R

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
#' @param uri URI specifying path to create the TileDB array object
2626
#' @param schema tiledb_array_schema object
2727
#' @param encryption_key optional A character value with an AES-256 encryption key
28-
#' in case the array should be encryption.
28+
#' in case the array should be encrypted.
2929
#'
3030
#' @examples
3131
#' \dontshow{
@@ -181,9 +181,9 @@ tiledb_array_is_heterogeneous <- function(arr) {
181181
##' @return A boolean indicating success
182182
##' @export
183183
tiledb_array_delete_fragments <- function(
184-
arr,
185-
ts_start,
186-
ts_end,
184+
arr,
185+
ts_start,
186+
ts_end,
187187
ctx = tiledb_get_context()
188188
) {
189189
stopifnot(
@@ -197,15 +197,15 @@ tiledb_array_delete_fragments <- function(
197197

198198
##' Delete fragments written given by their URIs
199199
##'
200-
##' @param arr A TileDB Array object as for example returned by
200+
##' @param arr A TileDB Array object as for example returned by
201201
##' \code{tiledb_array()}
202202
##' @param fragments A character vector with fragment URIs
203203
##' @param ctx A tiledb_ctx object (optional)
204204
##' @return A boolean indicating success
205205
##' @export
206206
tiledb_array_delete_fragments_list <- function(
207-
arr,
208-
fragments,
207+
arr,
208+
fragments,
209209
ctx = tiledb_get_context()
210210
) {
211211
stopifnot(
@@ -247,7 +247,7 @@ tiledb_array_has_enumeration <- function(arr) {
247247
##' @return The value of the aggregation
248248
##' @export
249249
tiledb_array_apply_aggregate <- function(
250-
array,
250+
array,
251251
attrname,
252252
operation = c("Count", "NullCount", "Min", "Max", "Mean", "Sum"),
253253
nullable = TRUE
@@ -283,8 +283,8 @@ tiledb_array_apply_aggregate <- function(
283283
##' @return Nothing is returned as the function is invoked for its side effect
284284
##' @export
285285
tiledb_array_upgrade_version <- function(
286-
array,
287-
config = NULL,
286+
array,
287+
config = NULL,
288288
ctx = tiledb_get_context()
289289
) {
290290
stopifnot(

0 commit comments

Comments
 (0)