Skip to content

Commit

Permalink
document that rcrds require a format method
Browse files Browse the repository at this point in the history
  • Loading branch information
JosiahParry authored Oct 22, 2024
1 parent 8d98911 commit 1ec55a2
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions R/type-rcrd.R
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@
#' (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 1ec55a2

Please sign in to comment.