Skip to content

Commit

Permalink
address PR requestions
Browse files Browse the repository at this point in the history
  • Loading branch information
JosiahParry committed Oct 23, 2024
1 parent 1ec55a2 commit 95db5ae
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions R/type-rcrd.R
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,17 @@
#' classes that can naturally be decomposed into multiple vectors of the same
#' length, like [POSIXlt], but where the organisation should be considered
#' an implementation detail invisible to the user (unlike a [data.frame]).
#'
#' @details
#' Record-style objects created with [new_rcrd()] do not have a default
#' [format()] method. See [Record-style objects](https://vctrs.r-lib.org/articles/s3-vector.html?q=record#record-style-objects
#' for more details on implementing other methods.
#'
#' @param fields A list or a data frame. Lists must be rectangular
#' (same sizes), and contain uniquely named vectors (at least
#' one). `fields` is validated with [df_list()] to ensure uniquely
#' named vectors.
#' @details
#' A new rcrd class created with [new_rcrd()] will not have a [format()] method.
#' New classes must implement their own [format()] method. See [Record-style objects](https://vctrs.r-lib.org/articles/s3-vector.html?q=record#record-style-objects) for more.
#'
#' @param ... Additional attributes
#' @param class Name of subclass.
#' @export
Expand Down

0 comments on commit 95db5ae

Please sign in to comment.