Skip to content

Fix diff_str documentation circular reference #802

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
tanmaydimriGSOC wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix diff_str documentation circular reference #802

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions R/diff.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,9 +77,10 @@ diff_chr <- function(old, new, max_dist = Inf) {
#' @param old First string, must not be `NA`.
#' @param new Second string, must not be `NA`.
#' @inheritParams diff_chr
#' @return A list that is a `cli_diff_str` object and also a
#' `cli_diff_chr` object, see [diff_str] for the details about its
#' structure.
#' @return A list with class `cli_diff_str` and `cli_diff_chr`.
#' It represents the character-by-character diff between the input
#' strings and is primarily intended for printing.
#' See [print.cli_diff_str] and [format.cli_diff_str] for details.
#'
#' @family diff functions in cli
#' @seealso The diffobj package for a much more comprehensive set of
Expand Down
Loading