Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: new_rcrd() requires a format method #1954

Merged
merged 4 commits into from
Oct 28, 2024
Merged

doc: new_rcrd() requires a format method #1954

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1ec55a2
document that rcrds require a format method
JosiahParry Oct 22, 2024
95db5ae
address PR requestions
JosiahParry Oct 23, 2024
756f66b
Update R/type-rcrd.R
JosiahParry Oct 23, 2024
0fe5bce
Tweak
lionel- Oct 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions R/type-rcrd.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +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.
#'
JosiahParry marked this conversation as resolved.
Show resolved Hide resolved
#' @param ... Additional attributes
#' @param class Name of subclass.
#' @export
Expand Down
Loading