More doc cleaning

Author: nealrichardson

r/R/array.R

@@ -17,32 +17,24 @@
 
 #' @include arrow-package.R
 
-#' @title class Array
-#'
-#' Array base type. Immutable data array with some logical type and some length.
-#'
+#' @title Array class
+#' @description Array base type. Immutable data array with some logical type
+#' and some length.
 #' @usage NULL
 #' @format NULL
 #' @docType class
 #'
+#' @section Factory:
+#' The `Array$create()` factory method instantiates an `Array` and
+#' takes the following arguments:
+#' * `x`: an R vector, list, or `data.frame`
+#' * `type`: an optional [data type][data-type] for `x`. If omitted, the type
+#'    will be inferred from the data.
 #' @section Usage:
 #'
 #' ```
 #' a <- Array$create(x)
-#'
-#' a$IsNull(i)
-#' a$IsValid(i)
-#' a$length() or length(a)
-#' a$offset()
-#' a$null_count()
-#' a$type()
-#' a$type_id()
-#' a$Equals(b)
-#' a$ApproxEquals(b)
-#' a$as_vector()
-#' a$ToString()
-#' a$Slice(offset, length = NULL)
-#' a$RangeEquals(other, start_idx, end_idx, other_start_idx)
+#' length(a)
 #'
 #' print(a)
 #' a == a

r/R/buffer.R

@@ -15,11 +15,14 @@
 # specific language governing permissions and limitations
 # under the License.
 
-#' @title class Buffer
+#' @title Buffer class
 #' @usage NULL
 #' @format NULL
 #' @docType class
-#' @description `buffer()` lets you create an `arrow::Buffer` from an R object
+#' @description A Buffer is an object containing a pointer to a piece of
+#' contiguous memory with a particular size.
+#' @section Factory:
+#' `buffer()` lets you create an `arrow::Buffer` from an R object
 #' @section Methods:
 #'
 #' - `$is_mutable()` :

r/R/chunked-array.R

@@ -17,18 +17,31 @@
 
 #' @include arrow-package.R
 
-#' @title class ChunkedArray
-#'
+#' @title ChunkedArray class
 #' @usage NULL
 #' @format NULL
 #' @docType class
+#' @description A `ChunkedArray` is a data structure managing a list of
+#' primitive Arrow [Arrays][Array] logically as one large array.
+#' @section Factory:
+#' The `ChunkedArray$create()` factory method instantiates the object from
+#' various Arrays or R vectors. `chunked_array()` is an alias for it.
 #'
 #' @section Methods:
 #'
-#' TODO
+#' - `$length()`
+#' - `$chunk(i)`
+#' - `$as_vector()`
+#' - `$Slice(offset, length = NULL)`
+#' - `$cast(target_type, safe = TRUE, options = cast_options(safe))`
+#' - `$null_count()`
+#' - `$chunks()`
+#' - `$num_chunks()`
+#' - `$type()`
 #'
-#' @rdname chunked-array
-#' @name chunked-array
+#' @rdname ChunkedArray
+#' @name ChunkedArray
+#' @seealso [Array]
 #' @export
 ChunkedArray <- R6Class("ChunkedArray", inherit = Object,
   public = list(
@@ -60,10 +73,8 @@ ChunkedArray$create <- function(..., type = NULL) {
   shared_ptr(ChunkedArray, ChunkedArray__from_list(list2(...), type))
 }
 
-#' Create a [ChunkedArray][chunked-array] from various R vectors
-#'
 #' @param \dots Vectors to coerce
 #' @param type currently ignored
-#'
+#' @rdname ChunkedArray
 #' @export
 chunked_array <- ChunkedArray$create

r/R/schema.R

@@ -87,14 +87,14 @@ read_schema.InputStream <- function(stream, ...) {
 }
 
 #' @export
-`read_schema.Buffer` <- function(stream, ...) {
+read_schema.Buffer <- function(stream, ...) {
   stream <- BufferReader$create(stream)
   on.exit(stream$close())
   shared_ptr(Schema, ipc___ReadSchema_InputStream(stream))
 }
 
 #' @export
-`read_schema.raw` <- function(stream, ...) {
+read_schema.raw <- function(stream, ...) {
   stream <- BufferReader$create(stream)
   on.exit(stream$close())
   shared_ptr(Schema, ipc___ReadSchema_InputStream(stream))