docs: note that ansi_substr/ansi_substring do not support replacement form

R/ansiex.R

@@ -151,9 +151,11 @@ ansi_nchar <- function(
 #' Substring(s) of an ANSI colored string
 #'
 #' This is a color-aware counterpart of [base::substr()].
-#' It works exactly like the original, but keeps the colors
+#' It works like the original, but keeps the colors
 #' in the substrings. The ANSI escape sequences are ignored when
 #' calculating the positions within the string.
+#' Unlike [base::substr()], the replacement form
+#' (`ansi_substr(x, start, stop) <- value`) is not supported.
 #'
 #' @param x Character vector, potentially ANSI styled, or a vector to
 #'   coerced to character.
@@ -236,9 +238,11 @@ ansi_substr <- function(x, start, stop) {
 #' Substring(s) of an ANSI colored string
 #'
 #' This is the color-aware counterpart of [base::substring()].
-#' It works exactly like the original, but keeps the colors in the
+#' It works like the original, but keeps the colors in the
 #' substrings. The ANSI escape sequences are ignored when
 #' calculating the positions within the string.
+#' Unlike [base::substring()], the replacement form
+#' (`substring(text, first, last) <- value`) is not supported.
 #'
 #' @param text Character vector, potentially ANSI styled, or a vector to
 #'   coerced to character. It is recycled to the longest of `first`

R/bullets.R

@@ -70,7 +70,7 @@ cli_bullets <- function(
 
 #' List of verbatim items
 #'
-#' `cli_format_bullets_raw()` is similar to [cli_bullets()], but it does
+#' `cli_bullets_raw()` is similar to [cli_bullets()], but it does
 #' not perform any inline styling or glue substitutions in the input.
 #'
 #' `format_bullets_raw()` returns the output instead of printing it.

R/format-conditions.R

@@ -26,6 +26,7 @@
 #' @param message It is formatted via a call to [cli_bullets()].
 #' @param .envir Environment to evaluate the glue expressions in.
 #'
+#' @return A character string containing the formatted message.
 #' @seealso These functions support [inline markup][inline-markup].
 #' @family functions supporting inline markup
 #' @export

R/ruler.R

@@ -1,5 +1,7 @@
 #' Print the helpful ruler to the screen
 #'
+#' @return `NULL`, invisibly. Called for its side effect of printing a
+#'   ruler to the screen.
 #' @export
 #' @param width Ruler width.
 #' @examples

R/simple-theme.R

@@ -60,6 +60,7 @@
 #'   Detection usually works in recent RStudio versions, and in iTerm
 #'   on macOS, but not on other platforms.
 #'
+#' @return A named list that can be used as a cli theme.
 #' @seealso [themes], [builtin_theme()].
 #' @export
 

R/spark.R

@@ -34,6 +34,7 @@
 #' ```
 #'
 #' @param x A numeric vector between 0 and 1
+#' @return A character string of class `cli_spark_bar` and `cli_spark`.
 #' @export
 #' @seealso [spark_line()]
 
@@ -95,6 +96,7 @@ spark_bar_chars <- function(x, bars = NULL) {
 #' ```
 #'
 #' @inheritParams spark_bar
+#' @return A character string of class `cli_spark_line` and `cli_spark`.
 #' @export
 #' @seealso [spark_bar()]
 

R/test.R

@@ -41,6 +41,8 @@
 #'   * `"all"`: turn on all hyperlinks,
 #'   * `"none"`: turn off all hyperlinks.
 #'
+#' @return The return value of [testthat::test_that()] for the last
+#'   configuration tested (invisibly).
 #' @export
 #' @examples
 #' # testthat cannot record or compare snapshots when you run these