Document and export ansi_string

NAMESPACE

@@ -46,6 +46,7 @@ export(ansi_palettes)
 export(ansi_regex)
 export(ansi_show_cursor)
 export(ansi_simplify)
+export(ansi_string)
 export(ansi_strip)
 export(ansi_strsplit)
 export(ansi_strtrim)

NEWS.md

@@ -3,6 +3,8 @@
 * `ansi_collapse(x, trunc = 1, style = "head")` now indeed show one element
   if `length(x) == 2`, as documented (@salim-b, #572).
 
+* `ansi_string()` is now an exported function (@multimeric, #573).
+
 # cli 3.6.1
 
 * ANSI hyperlinks are now turned off on the RStudio render plane (#581).

R/ansiex.R

@@ -1,4 +1,15 @@
-
+#' Labels a character vector as containing ANSI control codes.
+#'
+#' This function sets the class of its argument, activating
+#' ANSI-string-specific methods such as for printing.
+#'
+#' @param x A character vector or something that can be
+#'   coerced into one.
+#' @return A `cli_ansi_string` object, a subclass of
+#'   `character`, with the same length and contents
+#'   as `x`.
+#' @family low level ANSI functions
+#' @export
 ansi_string <- function(x) {
   if (!is.character(x)) x <- as.character(x)
   x <- enc2utf8(x)

_pkgdown.yml

@@ -154,6 +154,7 @@ reference:
   - ansi_nzchar
   - ansi_regex
   - ansi_simplify
+  - ansi_string
   - ansi_strip
   - ansi_strsplit
   - ansi_strtrim