Skip to content

Commit 78d9f2b

Browse files
authored
Mention in doc that new_rcrd() requires a format method (#1954)
1 parent 8d98911 commit 78d9f2b

File tree

2 files changed

+12
-0
lines changed

2 files changed

+12
-0
lines changed

R/type-rcrd.R

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,12 @@
88
#' length, like [POSIXlt], but where the organisation should be considered
99
#' an implementation detail invisible to the user (unlike a [data.frame]).
1010
#'
11+
#' @details
12+
#' Record-style objects created with [new_rcrd()] do not do much on their own.
13+
#' For instance they do not have a default [format()] method, which means printing
14+
#' the object causes an error. See [Record-style objects](https://vctrs.r-lib.org/articles/s3-vector.html?q=record#record-style-objects
15+
#' for details on implementing methods for record vectors.
16+
#'
1117
#' @param fields A list or a data frame. Lists must be rectangular
1218
#' (same sizes), and contain uniquely named vectors (at least
1319
#' one). `fields` is validated with [df_list()] to ensure uniquely

man/new_rcrd.Rd

Lines changed: 6 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)