diff --git a/R/multi.R b/R/multi.R index ea54ddd07..d7a29d0be 100644 --- a/R/multi.R +++ b/R/multi.R @@ -1,6 +1,8 @@ #' Format multiple vectors in a tabular display #' #' @description +#' `r lifecycle::badge("soft-deprecated")` +#' #' The vectors are formatted to fit horizontally into a user-supplied number of #' characters per row. #' @@ -107,6 +109,9 @@ new_empty_col_sentinel <- function(type) { #' Squeeze a colonnade to a fixed width #' +#' @description +#' `r lifecycle::badge("soft-deprecated")` +#' #' The `squeeze()` function usually doesn't need to be called manually. #' It returns an object suitable for printing and formatting at a fixed width #' with additional information about omitted columns, which can be retrieved @@ -223,6 +228,9 @@ knit_print_squeezed_colonnade_tier <- function(x) { #' Retrieve information about columns that didn't fit the available width #' +#' @description +#' `r lifecycle::badge("soft-deprecated")` +#' #' Formatting a [colonnade] object may lead to some columns being omitted #' due to width restrictions. This method returns a character vector that #' describes each of the omitted columns. diff --git a/man/colonnade.Rd b/man/colonnade.Rd index 5c3331a10..a4430dea6 100644 --- a/man/colonnade.Rd +++ b/man/colonnade.Rd @@ -19,6 +19,8 @@ the row ID column with a star.} \item{...}{These dots are for future extensions and must be empty.} } \description{ +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#soft-deprecated}{\figure{lifecycle-soft-deprecated.svg}{options: alt='[Soft-deprecated]'}}}{\strong{[Soft-deprecated]}} + The vectors are formatted to fit horizontally into a user-supplied number of characters per row. diff --git a/man/extra_cols.Rd b/man/extra_cols.Rd index e9b75dbc2..a304156aa 100644 --- a/man/extra_cols.Rd +++ b/man/extra_cols.Rd @@ -19,6 +19,8 @@ always contain as many elements as there are extra columns, but elements beyond \code{n} will be \code{NA}.} } \description{ +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#soft-deprecated}{\figure{lifecycle-soft-deprecated.svg}{options: alt='[Soft-deprecated]'}}}{\strong{[Soft-deprecated]}} + Formatting a \link{colonnade} object may lead to some columns being omitted due to width restrictions. This method returns a character vector that describes each of the omitted columns. diff --git a/man/squeeze.Rd b/man/squeeze.Rd index eddcf715c..06d139883 100644 --- a/man/squeeze.Rd +++ b/man/squeeze.Rd @@ -7,6 +7,8 @@ squeeze(x, width = NULL, ...) } \description{ +\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#soft-deprecated}{\figure{lifecycle-soft-deprecated.svg}{options: alt='[Soft-deprecated]'}}}{\strong{[Soft-deprecated]}} + The \code{squeeze()} function usually doesn't need to be called manually. It returns an object suitable for printing and formatting at a fixed width with additional information about omitted columns, which can be retrieved