From 4f36d63b48a9d03581dafdeae449407a6edc647e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Kirill=20M=C3=BCller?= Date: Fri, 23 Jul 2021 04:26:58 +0200 Subject: [PATCH] Tweak documentation of return value --- R/enframe.R | 3 ++- man/enframe.Rd | 4 +++- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/R/enframe.R b/R/enframe.R index e0d3eaa92..53ce31f44 100644 --- a/R/enframe.R +++ b/R/enframe.R @@ -11,7 +11,7 @@ #' @param name,value Names of the columns that store the names and values. #' If `name` is `NULL`, a one-column tibble is returned; `value` cannot be `NULL`. #' -#' @return A [tibble] with two columns (if `name` is not `NULL`, the default) +#' @return Fpr `enframe()`, a [tibble] with two columns (if `name` is not `NULL`, the default) #' or one column (otherwise). #' @export #' @@ -59,6 +59,7 @@ vectbl_set_names <- function(x, names = NULL) { #' `deframe()` converts two-column data frames to a named vector or list, #' using the first column as name and the second column as value. #' If the input has only one column, an unnamed vector is returned. +#' @return For `deframe()`, a vector (named or unnamed). #' @export #' @examples #' deframe(enframe(3:1)) diff --git a/man/enframe.Rd b/man/enframe.Rd index 0c7a58fe7..c1476d056 100644 --- a/man/enframe.Rd +++ b/man/enframe.Rd @@ -17,8 +17,10 @@ deframe(x) If \code{name} is \code{NULL}, a one-column tibble is returned; \code{value} cannot be \code{NULL}.} } \value{ -A \link{tibble} with two columns (if \code{name} is not \code{NULL}, the default) +Fpr \code{enframe()}, a \link{tibble} with two columns (if \code{name} is not \code{NULL}, the default) or one column (otherwise). + +For \code{deframe()}, a vector (named or unnamed). } \description{ \code{enframe()} converts named atomic vectors or lists to one- or two-column