Skip to content

Commit

Permalink
Mention in doc that new_rcrd() requires a format method (#1954)
Browse files Browse the repository at this point in the history
  • Loading branch information
JosiahParry authored Oct 28, 2024
1 parent 8d98911 commit 78d9f2b
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 0 deletions.
6 changes: 6 additions & 0 deletions R/type-rcrd.R
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,12 @@
#' 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 do much on their own.
#' For instance they do not have a default [format()] method, which means printing
#' the object causes an error. See [Record-style objects](https://vctrs.r-lib.org/articles/s3-vector.html?q=record#record-style-objects
#' for details on implementing methods for record vectors.
#'
#' @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
Expand Down
6 changes: 6 additions & 0 deletions man/new_rcrd.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 78d9f2b

Please sign in to comment.