From 95db5ae65b60e1b99c4c3dbae3b3dc62d57b6708 Mon Sep 17 00:00:00 2001 From: Josiah Parry Date: Wed, 23 Oct 2024 11:16:01 -0700 Subject: [PATCH] address PR requestions --- R/type-rcrd.R | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/R/type-rcrd.R b/R/type-rcrd.R index 808b1c10b..0800a3fa8 100644 --- a/R/type-rcrd.R +++ b/R/type-rcrd.R @@ -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