From 13ff424cec716cd12e703f01c5b3eef501873a6f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?G=C3=A1bor=20Cs=C3=A1rdi?= Date: Wed, 28 Aug 2024 12:26:48 +0200 Subject: [PATCH] Update manual --- DESCRIPTION | 2 +- man/ansi_align.Rd | 2 +- man/ansi_collapse.Rd | 5 +++-- man/ansi_columns.Rd | 2 +- man/ansi_nchar.Rd | 2 +- man/ansi_strsplit.Rd | 2 +- man/ansi_strtrim.Rd | 2 +- man/ansi_strwrap.Rd | 2 +- man/ansi_toupper.Rd | 6 +++--- man/ansi_trimws.Rd | 2 +- man/cli_abort.Rd | 4 ++-- man/cli_alert.Rd | 4 ++-- man/cli_blockquote.Rd | 4 ++-- man/cli_bullets.Rd | 2 +- man/cli_bullets_raw.Rd | 2 +- man/cli_dl.Rd | 4 ++-- man/cli_h1.Rd | 4 ++-- man/cli_li.Rd | 4 ++-- man/cli_ol.Rd | 4 ++-- man/cli_process_start.Rd | 8 ++++---- man/cli_progress_along.Rd | 4 ++-- man/cli_progress_bar.Rd | 4 ++-- man/cli_progress_message.Rd | 4 ++-- man/cli_progress_output.Rd | 4 ++-- man/cli_progress_step.Rd | 4 ++-- man/cli_rule.Rd | 4 ++-- man/cli_status.Rd | 2 +- man/cli_status_clear.Rd | 4 ++-- man/cli_status_update.Rd | 6 +++--- man/cli_text.Rd | 4 ++-- man/cli_ul.Rd | 4 ++-- man/format_error.Rd | 4 ++-- man/format_inline.Rd | 4 ++-- man/inline-markup.Rd | 3 ++- man/pluralization-helpers.Rd | 14 ++++++++++++++ 35 files changed, 76 insertions(+), 60 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index 4e5c0e03d..c9a722517 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -59,4 +59,4 @@ Config/Needs/website: vctrs Config/testthat/edition: 3 Encoding: UTF-8 -RoxygenNote: 7.2.3 +RoxygenNote: 7.3.2 diff --git a/man/ansi_align.Rd b/man/ansi_align.Rd index e9886d11a..17a716875 100644 --- a/man/ansi_align.Rd +++ b/man/ansi_align.Rd @@ -87,8 +87,8 @@ Other ANSI string operations: \code{\link{ansi_strsplit}()}, \code{\link{ansi_strtrim}()}, \code{\link{ansi_strwrap}()}, -\code{\link{ansi_substring}()}, \code{\link{ansi_substr}()}, +\code{\link{ansi_substring}()}, \code{\link{ansi_toupper}()}, \code{\link{ansi_trimws}()} } diff --git a/man/ansi_collapse.Rd b/man/ansi_collapse.Rd index 4e90d0648..4fb5a1fd3 100644 --- a/man/ansi_collapse.Rd +++ b/man/ansi_collapse.Rd @@ -7,7 +7,7 @@ ansi_collapse( x, sep = ", ", - sep2 = " and ", + sep2 = sub("^,", "", last), last = ", and ", trunc = Inf, width = Inf, @@ -22,7 +22,8 @@ to collapse.} \item{sep}{Separator. A character string.} \item{sep2}{Separator for the special case that \code{x} contains only two -elements. A character string.} +elements. A character string. Defaults to the value of \code{last} without the +serial comma.} \item{last}{Last separator, if there is no truncation. E.g. use \code{", and "} for the \href{https://en.wikipedia.org/wiki/Serial_comma}{serial comma}. A character string.} diff --git a/man/ansi_columns.Rd b/man/ansi_columns.Rd index add06afd0..dd9b1235c 100644 --- a/man/ansi_columns.Rd +++ b/man/ansi_columns.Rd @@ -72,8 +72,8 @@ Other ANSI string operations: \code{\link{ansi_strsplit}()}, \code{\link{ansi_strtrim}()}, \code{\link{ansi_strwrap}()}, -\code{\link{ansi_substring}()}, \code{\link{ansi_substr}()}, +\code{\link{ansi_substring}()}, \code{\link{ansi_toupper}()}, \code{\link{ansi_trimws}()} } diff --git a/man/ansi_nchar.Rd b/man/ansi_nchar.Rd index edf3219ae..23a32d868 100644 --- a/man/ansi_nchar.Rd +++ b/man/ansi_nchar.Rd @@ -40,8 +40,8 @@ Other ANSI string operations: \code{\link{ansi_strsplit}()}, \code{\link{ansi_strtrim}()}, \code{\link{ansi_strwrap}()}, -\code{\link{ansi_substring}()}, \code{\link{ansi_substr}()}, +\code{\link{ansi_substring}()}, \code{\link{ansi_toupper}()}, \code{\link{ansi_trimws}()} } diff --git a/man/ansi_strsplit.Rd b/man/ansi_strsplit.Rd index 020477f41..125466a9c 100644 --- a/man/ansi_strsplit.Rd +++ b/man/ansi_strsplit.Rd @@ -51,8 +51,8 @@ Other ANSI string operations: \code{\link{ansi_nchar}()}, \code{\link{ansi_strtrim}()}, \code{\link{ansi_strwrap}()}, -\code{\link{ansi_substring}()}, \code{\link{ansi_substr}()}, +\code{\link{ansi_substring}()}, \code{\link{ansi_toupper}()}, \code{\link{ansi_trimws}()} } diff --git a/man/ansi_strtrim.Rd b/man/ansi_strtrim.Rd index 9a1818732..c530c1f0b 100644 --- a/man/ansi_strtrim.Rd +++ b/man/ansi_strtrim.Rd @@ -34,8 +34,8 @@ Other ANSI string operations: \code{\link{ansi_nchar}()}, \code{\link{ansi_strsplit}()}, \code{\link{ansi_strwrap}()}, -\code{\link{ansi_substring}()}, \code{\link{ansi_substr}()}, +\code{\link{ansi_substring}()}, \code{\link{ansi_toupper}()}, \code{\link{ansi_trimws}()} } diff --git a/man/ansi_strwrap.Rd b/man/ansi_strwrap.Rd index 189de95dc..41d597d4b 100644 --- a/man/ansi_strwrap.Rd +++ b/man/ansi_strwrap.Rd @@ -50,8 +50,8 @@ Other ANSI string operations: \code{\link{ansi_nchar}()}, \code{\link{ansi_strsplit}()}, \code{\link{ansi_strtrim}()}, -\code{\link{ansi_substring}()}, \code{\link{ansi_substr}()}, +\code{\link{ansi_substring}()}, \code{\link{ansi_toupper}()}, \code{\link{ansi_trimws}()} } diff --git a/man/ansi_toupper.Rd b/man/ansi_toupper.Rd index b8ab6b846..66bdf3017 100644 --- a/man/ansi_toupper.Rd +++ b/man/ansi_toupper.Rd @@ -47,8 +47,8 @@ Other ANSI string operations: \code{\link{ansi_strsplit}()}, \code{\link{ansi_strtrim}()}, \code{\link{ansi_strwrap}()}, -\code{\link{ansi_substring}()}, \code{\link{ansi_substr}()}, +\code{\link{ansi_substring}()}, \code{\link{ansi_trimws}()} Other ANSI string operations: @@ -58,8 +58,8 @@ Other ANSI string operations: \code{\link{ansi_strsplit}()}, \code{\link{ansi_strtrim}()}, \code{\link{ansi_strwrap}()}, -\code{\link{ansi_substring}()}, \code{\link{ansi_substr}()}, +\code{\link{ansi_substring}()}, \code{\link{ansi_trimws}()} Other ANSI string operations: @@ -69,8 +69,8 @@ Other ANSI string operations: \code{\link{ansi_strsplit}()}, \code{\link{ansi_strtrim}()}, \code{\link{ansi_strwrap}()}, -\code{\link{ansi_substring}()}, \code{\link{ansi_substr}()}, +\code{\link{ansi_substring}()}, \code{\link{ansi_trimws}()} } \concept{ANSI string operations} diff --git a/man/ansi_trimws.Rd b/man/ansi_trimws.Rd index 5ca314b8b..2da8d219c 100644 --- a/man/ansi_trimws.Rd +++ b/man/ansi_trimws.Rd @@ -32,8 +32,8 @@ Other ANSI string operations: \code{\link{ansi_strsplit}()}, \code{\link{ansi_strtrim}()}, \code{\link{ansi_strwrap}()}, -\code{\link{ansi_substring}()}, \code{\link{ansi_substr}()}, +\code{\link{ansi_substring}()}, \code{\link{ansi_toupper}()} } \concept{ANSI string operations} diff --git a/man/cli_abort.Rd b/man/cli_abort.Rd index 25e5e29c1..c04859a61 100644 --- a/man/cli_abort.Rd +++ b/man/cli_abort.Rd @@ -89,8 +89,8 @@ These functions support \link[=inline-markup]{inline markup}. Other functions supporting inline markup: \code{\link{cli_alert}()}, \code{\link{cli_blockquote}()}, -\code{\link{cli_bullets_raw}()}, \code{\link{cli_bullets}()}, +\code{\link{cli_bullets_raw}()}, \code{\link{cli_dl}()}, \code{\link{cli_h1}()}, \code{\link{cli_li}()}, @@ -102,8 +102,8 @@ Other functions supporting inline markup: \code{\link{cli_progress_output}()}, \code{\link{cli_progress_step}()}, \code{\link{cli_rule}}, -\code{\link{cli_status_update}()}, \code{\link{cli_status}()}, +\code{\link{cli_status_update}()}, \code{\link{cli_text}()}, \code{\link{cli_ul}()}, \code{\link{format_error}()}, diff --git a/man/cli_alert.Rd b/man/cli_alert.Rd index f1ecd410b..736cd20fa 100644 --- a/man/cli_alert.Rd +++ b/man/cli_alert.Rd @@ -129,8 +129,8 @@ These functions supports \link[=inline-markup]{inline markup}. Other functions supporting inline markup: \code{\link{cli_abort}()}, \code{\link{cli_blockquote}()}, -\code{\link{cli_bullets_raw}()}, \code{\link{cli_bullets}()}, +\code{\link{cli_bullets_raw}()}, \code{\link{cli_dl}()}, \code{\link{cli_h1}()}, \code{\link{cli_li}()}, @@ -142,8 +142,8 @@ Other functions supporting inline markup: \code{\link{cli_progress_output}()}, \code{\link{cli_progress_step}()}, \code{\link{cli_rule}}, -\code{\link{cli_status_update}()}, \code{\link{cli_status}()}, +\code{\link{cli_status_update}()}, \code{\link{cli_text}()}, \code{\link{cli_ul}()}, \code{\link{format_error}()}, diff --git a/man/cli_blockquote.Rd b/man/cli_blockquote.Rd index 37b13074d..a5b520ac4 100644 --- a/man/cli_blockquote.Rd +++ b/man/cli_blockquote.Rd @@ -55,8 +55,8 @@ This function supports \link[=inline-markup]{inline markup}. Other functions supporting inline markup: \code{\link{cli_abort}()}, \code{\link{cli_alert}()}, -\code{\link{cli_bullets_raw}()}, \code{\link{cli_bullets}()}, +\code{\link{cli_bullets_raw}()}, \code{\link{cli_dl}()}, \code{\link{cli_h1}()}, \code{\link{cli_li}()}, @@ -68,8 +68,8 @@ Other functions supporting inline markup: \code{\link{cli_progress_output}()}, \code{\link{cli_progress_step}()}, \code{\link{cli_rule}}, -\code{\link{cli_status_update}()}, \code{\link{cli_status}()}, +\code{\link{cli_status_update}()}, \code{\link{cli_text}()}, \code{\link{cli_ul}()}, \code{\link{format_error}()}, diff --git a/man/cli_bullets.Rd b/man/cli_bullets.Rd index 7793fc86c..5027f9a18 100644 --- a/man/cli_bullets.Rd +++ b/man/cli_bullets.Rd @@ -86,8 +86,8 @@ Other functions supporting inline markup: \code{\link{cli_progress_output}()}, \code{\link{cli_progress_step}()}, \code{\link{cli_rule}}, -\code{\link{cli_status_update}()}, \code{\link{cli_status}()}, +\code{\link{cli_status_update}()}, \code{\link{cli_text}()}, \code{\link{cli_ul}()}, \code{\link{format_error}()}, diff --git a/man/cli_bullets_raw.Rd b/man/cli_bullets_raw.Rd index 3b3dfba45..d850fef1e 100644 --- a/man/cli_bullets_raw.Rd +++ b/man/cli_bullets_raw.Rd @@ -45,8 +45,8 @@ Other functions supporting inline markup: \code{\link{cli_progress_output}()}, \code{\link{cli_progress_step}()}, \code{\link{cli_rule}}, -\code{\link{cli_status_update}()}, \code{\link{cli_status}()}, +\code{\link{cli_status_update}()}, \code{\link{cli_text}()}, \code{\link{cli_ul}()}, \code{\link{format_error}()}, diff --git a/man/cli_dl.Rd b/man/cli_dl.Rd index 7b5866eea..2c39d51b1 100644 --- a/man/cli_dl.Rd +++ b/man/cli_dl.Rd @@ -84,8 +84,8 @@ Other functions supporting inline markup: \code{\link{cli_abort}()}, \code{\link{cli_alert}()}, \code{\link{cli_blockquote}()}, -\code{\link{cli_bullets_raw}()}, \code{\link{cli_bullets}()}, +\code{\link{cli_bullets_raw}()}, \code{\link{cli_h1}()}, \code{\link{cli_li}()}, \code{\link{cli_ol}()}, @@ -96,8 +96,8 @@ Other functions supporting inline markup: \code{\link{cli_progress_output}()}, \code{\link{cli_progress_step}()}, \code{\link{cli_rule}}, -\code{\link{cli_status_update}()}, \code{\link{cli_status}()}, +\code{\link{cli_status_update}()}, \code{\link{cli_text}()}, \code{\link{cli_ul}()}, \code{\link{format_error}()}, diff --git a/man/cli_h1.Rd b/man/cli_h1.Rd index a5b3c1e0f..e55bb61fd 100644 --- a/man/cli_h1.Rd +++ b/man/cli_h1.Rd @@ -49,8 +49,8 @@ Other functions supporting inline markup: \code{\link{cli_abort}()}, \code{\link{cli_alert}()}, \code{\link{cli_blockquote}()}, -\code{\link{cli_bullets_raw}()}, \code{\link{cli_bullets}()}, +\code{\link{cli_bullets_raw}()}, \code{\link{cli_dl}()}, \code{\link{cli_li}()}, \code{\link{cli_ol}()}, @@ -61,8 +61,8 @@ Other functions supporting inline markup: \code{\link{cli_progress_output}()}, \code{\link{cli_progress_step}()}, \code{\link{cli_rule}}, -\code{\link{cli_status_update}()}, \code{\link{cli_status}()}, +\code{\link{cli_status_update}()}, \code{\link{cli_text}()}, \code{\link{cli_ul}()}, \code{\link{format_error}()}, diff --git a/man/cli_li.Rd b/man/cli_li.Rd index cbb176164..cd6dd3ed0 100644 --- a/man/cli_li.Rd +++ b/man/cli_li.Rd @@ -68,8 +68,8 @@ Other functions supporting inline markup: \code{\link{cli_abort}()}, \code{\link{cli_alert}()}, \code{\link{cli_blockquote}()}, -\code{\link{cli_bullets_raw}()}, \code{\link{cli_bullets}()}, +\code{\link{cli_bullets_raw}()}, \code{\link{cli_dl}()}, \code{\link{cli_h1}()}, \code{\link{cli_ol}()}, @@ -80,8 +80,8 @@ Other functions supporting inline markup: \code{\link{cli_progress_output}()}, \code{\link{cli_progress_step}()}, \code{\link{cli_rule}}, -\code{\link{cli_status_update}()}, \code{\link{cli_status}()}, +\code{\link{cli_status_update}()}, \code{\link{cli_text}()}, \code{\link{cli_ul}()}, \code{\link{format_error}()}, diff --git a/man/cli_ol.Rd b/man/cli_ol.Rd index fe1531ebb..677988697 100644 --- a/man/cli_ol.Rd +++ b/man/cli_ol.Rd @@ -108,8 +108,8 @@ Other functions supporting inline markup: \code{\link{cli_abort}()}, \code{\link{cli_alert}()}, \code{\link{cli_blockquote}()}, -\code{\link{cli_bullets_raw}()}, \code{\link{cli_bullets}()}, +\code{\link{cli_bullets_raw}()}, \code{\link{cli_dl}()}, \code{\link{cli_h1}()}, \code{\link{cli_li}()}, @@ -120,8 +120,8 @@ Other functions supporting inline markup: \code{\link{cli_progress_output}()}, \code{\link{cli_progress_step}()}, \code{\link{cli_rule}}, -\code{\link{cli_status_update}()}, \code{\link{cli_status}()}, +\code{\link{cli_status_update}()}, \code{\link{cli_text}()}, \code{\link{cli_ul}()}, \code{\link{format_error}()}, diff --git a/man/cli_process_start.Rd b/man/cli_process_start.Rd index 631ebee68..d6238b0ef 100644 --- a/man/cli_process_start.Rd +++ b/man/cli_process_start.Rd @@ -118,16 +118,16 @@ The \code{\link[=cli_progress_message]{cli_progress_message()}} and \code{\link[ functions, for a superior API. Other status bar: +\code{\link{cli_status}()}, \code{\link{cli_status_clear}()}, -\code{\link{cli_status_update}()}, -\code{\link{cli_status}()} +\code{\link{cli_status_update}()} Other functions supporting inline markup: \code{\link{cli_abort}()}, \code{\link{cli_alert}()}, \code{\link{cli_blockquote}()}, -\code{\link{cli_bullets_raw}()}, \code{\link{cli_bullets}()}, +\code{\link{cli_bullets_raw}()}, \code{\link{cli_dl}()}, \code{\link{cli_h1}()}, \code{\link{cli_li}()}, @@ -138,8 +138,8 @@ Other functions supporting inline markup: \code{\link{cli_progress_output}()}, \code{\link{cli_progress_step}()}, \code{\link{cli_rule}}, -\code{\link{cli_status_update}()}, \code{\link{cli_status}()}, +\code{\link{cli_status_update}()}, \code{\link{cli_text}()}, \code{\link{cli_ul}()}, \code{\link{format_error}()}, diff --git a/man/cli_progress_along.Rd b/man/cli_progress_along.Rd index 88c900ae9..3b34b01dc 100644 --- a/man/cli_progress_along.Rd +++ b/man/cli_progress_along.Rd @@ -121,8 +121,8 @@ Other functions supporting inline markup: \code{\link{cli_abort}()}, \code{\link{cli_alert}()}, \code{\link{cli_blockquote}()}, -\code{\link{cli_bullets_raw}()}, \code{\link{cli_bullets}()}, +\code{\link{cli_bullets_raw}()}, \code{\link{cli_dl}()}, \code{\link{cli_h1}()}, \code{\link{cli_li}()}, @@ -133,8 +133,8 @@ Other functions supporting inline markup: \code{\link{cli_progress_output}()}, \code{\link{cli_progress_step}()}, \code{\link{cli_rule}}, -\code{\link{cli_status_update}()}, \code{\link{cli_status}()}, +\code{\link{cli_status_update}()}, \code{\link{cli_text}()}, \code{\link{cli_ul}()}, \code{\link{format_error}()}, diff --git a/man/cli_progress_bar.Rd b/man/cli_progress_bar.Rd index 8bf2ba299..bb9bfeb86 100644 --- a/man/cli_progress_bar.Rd +++ b/man/cli_progress_bar.Rd @@ -380,8 +380,8 @@ Other functions supporting inline markup: \code{\link{cli_abort}()}, \code{\link{cli_alert}()}, \code{\link{cli_blockquote}()}, -\code{\link{cli_bullets_raw}()}, \code{\link{cli_bullets}()}, +\code{\link{cli_bullets_raw}()}, \code{\link{cli_dl}()}, \code{\link{cli_h1}()}, \code{\link{cli_li}()}, @@ -392,8 +392,8 @@ Other functions supporting inline markup: \code{\link{cli_progress_output}()}, \code{\link{cli_progress_step}()}, \code{\link{cli_rule}}, -\code{\link{cli_status_update}()}, \code{\link{cli_status}()}, +\code{\link{cli_status_update}()}, \code{\link{cli_text}()}, \code{\link{cli_ul}()}, \code{\link{format_error}()}, diff --git a/man/cli_progress_message.Rd b/man/cli_progress_message.Rd index 9aa3fb679..023769095 100644 --- a/man/cli_progress_message.Rd +++ b/man/cli_progress_message.Rd @@ -79,8 +79,8 @@ Other functions supporting inline markup: \code{\link{cli_abort}()}, \code{\link{cli_alert}()}, \code{\link{cli_blockquote}()}, -\code{\link{cli_bullets_raw}()}, \code{\link{cli_bullets}()}, +\code{\link{cli_bullets_raw}()}, \code{\link{cli_dl}()}, \code{\link{cli_h1}()}, \code{\link{cli_li}()}, @@ -91,8 +91,8 @@ Other functions supporting inline markup: \code{\link{cli_progress_output}()}, \code{\link{cli_progress_step}()}, \code{\link{cli_rule}}, -\code{\link{cli_status_update}()}, \code{\link{cli_status}()}, +\code{\link{cli_status_update}()}, \code{\link{cli_text}()}, \code{\link{cli_ul}()}, \code{\link{format_error}()}, diff --git a/man/cli_progress_output.Rd b/man/cli_progress_output.Rd index ce43e33d9..6cbe4a64b 100644 --- a/man/cli_progress_output.Rd +++ b/man/cli_progress_output.Rd @@ -60,8 +60,8 @@ Other functions supporting inline markup: \code{\link{cli_abort}()}, \code{\link{cli_alert}()}, \code{\link{cli_blockquote}()}, -\code{\link{cli_bullets_raw}()}, \code{\link{cli_bullets}()}, +\code{\link{cli_bullets_raw}()}, \code{\link{cli_dl}()}, \code{\link{cli_h1}()}, \code{\link{cli_li}()}, @@ -72,8 +72,8 @@ Other functions supporting inline markup: \code{\link{cli_progress_message}()}, \code{\link{cli_progress_step}()}, \code{\link{cli_rule}}, -\code{\link{cli_status_update}()}, \code{\link{cli_status}()}, +\code{\link{cli_status_update}()}, \code{\link{cli_text}()}, \code{\link{cli_ul}()}, \code{\link{format_error}()}, diff --git a/man/cli_progress_step.Rd b/man/cli_progress_step.Rd index 37ef67943..6f12015a6 100644 --- a/man/cli_progress_step.Rd +++ b/man/cli_progress_step.Rd @@ -159,8 +159,8 @@ Other functions supporting inline markup: \code{\link{cli_abort}()}, \code{\link{cli_alert}()}, \code{\link{cli_blockquote}()}, -\code{\link{cli_bullets_raw}()}, \code{\link{cli_bullets}()}, +\code{\link{cli_bullets_raw}()}, \code{\link{cli_dl}()}, \code{\link{cli_h1}()}, \code{\link{cli_li}()}, @@ -171,8 +171,8 @@ Other functions supporting inline markup: \code{\link{cli_progress_message}()}, \code{\link{cli_progress_output}()}, \code{\link{cli_rule}}, -\code{\link{cli_status_update}()}, \code{\link{cli_status}()}, +\code{\link{cli_status_update}()}, \code{\link{cli_text}()}, \code{\link{cli_ul}()}, \code{\link{format_error}()}, diff --git a/man/cli_rule.Rd b/man/cli_rule.Rd index c18e4db4e..c42214c87 100644 --- a/man/cli_rule.Rd +++ b/man/cli_rule.Rd @@ -75,8 +75,8 @@ Other functions supporting inline markup: \code{\link{cli_abort}()}, \code{\link{cli_alert}()}, \code{\link{cli_blockquote}()}, -\code{\link{cli_bullets_raw}()}, \code{\link{cli_bullets}()}, +\code{\link{cli_bullets_raw}()}, \code{\link{cli_dl}()}, \code{\link{cli_h1}()}, \code{\link{cli_li}()}, @@ -87,8 +87,8 @@ Other functions supporting inline markup: \code{\link{cli_progress_message}()}, \code{\link{cli_progress_output}()}, \code{\link{cli_progress_step}()}, -\code{\link{cli_status_update}()}, \code{\link{cli_status}()}, +\code{\link{cli_status_update}()}, \code{\link{cli_text}()}, \code{\link{cli_ul}()}, \code{\link{format_error}()}, diff --git a/man/cli_status.Rd b/man/cli_status.Rd index 070589d3d..dbb6fa5ef 100644 --- a/man/cli_status.Rd +++ b/man/cli_status.Rd @@ -80,8 +80,8 @@ Other functions supporting inline markup: \code{\link{cli_abort}()}, \code{\link{cli_alert}()}, \code{\link{cli_blockquote}()}, -\code{\link{cli_bullets_raw}()}, \code{\link{cli_bullets}()}, +\code{\link{cli_bullets_raw}()}, \code{\link{cli_dl}()}, \code{\link{cli_h1}()}, \code{\link{cli_li}()}, diff --git a/man/cli_status_clear.Rd b/man/cli_status_clear.Rd index 6f00e8404..875ae0f89 100644 --- a/man/cli_status_clear.Rd +++ b/man/cli_status_clear.Rd @@ -45,7 +45,7 @@ functions, for a superior API. Other status bar: \code{\link{cli_process_start}()}, -\code{\link{cli_status_update}()}, -\code{\link{cli_status}()} +\code{\link{cli_status}()}, +\code{\link{cli_status_update}()} } \concept{status bar} diff --git a/man/cli_status_update.Rd b/man/cli_status_update.Rd index 04f5d17dc..9045f2f9b 100644 --- a/man/cli_status_update.Rd +++ b/man/cli_status_update.Rd @@ -45,15 +45,15 @@ functions, for a superior API. Other status bar: \code{\link{cli_process_start}()}, -\code{\link{cli_status_clear}()}, -\code{\link{cli_status}()} +\code{\link{cli_status}()}, +\code{\link{cli_status_clear}()} Other functions supporting inline markup: \code{\link{cli_abort}()}, \code{\link{cli_alert}()}, \code{\link{cli_blockquote}()}, -\code{\link{cli_bullets_raw}()}, \code{\link{cli_bullets}()}, +\code{\link{cli_bullets_raw}()}, \code{\link{cli_dl}()}, \code{\link{cli_h1}()}, \code{\link{cli_li}()}, diff --git a/man/cli_text.Rd b/man/cli_text.Rd index 4b1758a7f..c3027099d 100644 --- a/man/cli_text.Rd +++ b/man/cli_text.Rd @@ -133,8 +133,8 @@ Other functions supporting inline markup: \code{\link{cli_abort}()}, \code{\link{cli_alert}()}, \code{\link{cli_blockquote}()}, -\code{\link{cli_bullets_raw}()}, \code{\link{cli_bullets}()}, +\code{\link{cli_bullets_raw}()}, \code{\link{cli_dl}()}, \code{\link{cli_h1}()}, \code{\link{cli_li}()}, @@ -146,8 +146,8 @@ Other functions supporting inline markup: \code{\link{cli_progress_output}()}, \code{\link{cli_progress_step}()}, \code{\link{cli_rule}}, -\code{\link{cli_status_update}()}, \code{\link{cli_status}()}, +\code{\link{cli_status_update}()}, \code{\link{cli_ul}()}, \code{\link{format_error}()}, \code{\link{format_inline}()} diff --git a/man/cli_ul.Rd b/man/cli_ul.Rd index a5f13b3ff..b9e18a7e9 100644 --- a/man/cli_ul.Rd +++ b/man/cli_ul.Rd @@ -83,8 +83,8 @@ Other functions supporting inline markup: \code{\link{cli_abort}()}, \code{\link{cli_alert}()}, \code{\link{cli_blockquote}()}, -\code{\link{cli_bullets_raw}()}, \code{\link{cli_bullets}()}, +\code{\link{cli_bullets_raw}()}, \code{\link{cli_dl}()}, \code{\link{cli_h1}()}, \code{\link{cli_li}()}, @@ -96,8 +96,8 @@ Other functions supporting inline markup: \code{\link{cli_progress_output}()}, \code{\link{cli_progress_step}()}, \code{\link{cli_rule}}, -\code{\link{cli_status_update}()}, \code{\link{cli_status}()}, +\code{\link{cli_status_update}()}, \code{\link{cli_text}()}, \code{\link{format_error}()}, \code{\link{format_inline}()} diff --git a/man/format_error.Rd b/man/format_error.Rd index b09790fba..b59585624 100644 --- a/man/format_error.Rd +++ b/man/format_error.Rd @@ -59,8 +59,8 @@ Other functions supporting inline markup: \code{\link{cli_abort}()}, \code{\link{cli_alert}()}, \code{\link{cli_blockquote}()}, -\code{\link{cli_bullets_raw}()}, \code{\link{cli_bullets}()}, +\code{\link{cli_bullets_raw}()}, \code{\link{cli_dl}()}, \code{\link{cli_h1}()}, \code{\link{cli_li}()}, @@ -72,8 +72,8 @@ Other functions supporting inline markup: \code{\link{cli_progress_output}()}, \code{\link{cli_progress_step}()}, \code{\link{cli_rule}}, -\code{\link{cli_status_update}()}, \code{\link{cli_status}()}, +\code{\link{cli_status_update}()}, \code{\link{cli_text}()}, \code{\link{cli_ul}()}, \code{\link{format_inline}()} diff --git a/man/format_inline.Rd b/man/format_inline.Rd index 673f82d1d..9be129ce1 100644 --- a/man/format_inline.Rd +++ b/man/format_inline.Rd @@ -42,8 +42,8 @@ Other functions supporting inline markup: \code{\link{cli_abort}()}, \code{\link{cli_alert}()}, \code{\link{cli_blockquote}()}, -\code{\link{cli_bullets_raw}()}, \code{\link{cli_bullets}()}, +\code{\link{cli_bullets_raw}()}, \code{\link{cli_dl}()}, \code{\link{cli_h1}()}, \code{\link{cli_li}()}, @@ -55,8 +55,8 @@ Other functions supporting inline markup: \code{\link{cli_progress_output}()}, \code{\link{cli_progress_step}()}, \code{\link{cli_rule}}, -\code{\link{cli_status_update}()}, \code{\link{cli_status}()}, +\code{\link{cli_status_update}()}, \code{\link{cli_text}()}, \code{\link{cli_ul}()}, \code{\link{format_error}()} diff --git a/man/inline-markup.Rd b/man/inline-markup.Rd index c281c451d..28f3d5c7b 100644 --- a/man/inline-markup.Rd +++ b/man/inline-markup.Rd @@ -99,7 +99,8 @@ collapsed vectors (see below) from "and" to "or". \item \code{run} is an R expression, that is potentially clickable if the terminal supports ANSI hyperlinks to runnable code (e.g. RStudio). It supports link text. See \link{links} for more information about cli hyperlinks. -\item \code{str} for a double quoted string escaped by \code{\link[base:encodeString]{base::encodeString()}}.#' * \code{strong} for strong importance. +\item \code{str} for a double quoted string escaped by \code{\link[base:encodeString]{base::encodeString()}}. +\item \code{strong} for strong importance. \item \code{topic} is a help page of a \emph{topic}. If the terminal supports ANSI hyperlinks to help pages (e.g. RStudio), then cli creates a clickable link. It supports link text. diff --git a/man/pluralization-helpers.Rd b/man/pluralization-helpers.Rd index f9700edd5..bcb46dfdd 100644 --- a/man/pluralization-helpers.Rd +++ b/man/pluralization-helpers.Rd @@ -17,6 +17,20 @@ anything. See examples below.} } \description{ Pluralization helper functions +} +\examples{ +nfile <- 0; cli_text("Found {no(nfile)} file{?s}.") + +#> Found no files. + +nfile <- 1; cli_text("Found {no(nfile)} file{?s}.") + +#> Found 1 file. + +nfile <- 2; cli_text("Found {no(nfile)} file{?s}.") + +#> Found 2 files. + } \seealso{ Other pluralization: