typos

[musvaage]

R version 4.5.0

Fixing some typos and then running roxygen2::roxygenise() to regenerate the relevant .Rd files fails.

✖ cliapp-docs.R:179: @section has mismatched braces or quotes.
Error in collapse(c(x$value$title, y$value$title), c(x$value$content,  : 
  length(key) == length(value) is not TRUE
In addition: Warning message:
Failed to source `man/roxygen/meta.R` 

@gaborcsardi

https://github.com./r-lib/cli/pull/492

Was a correction for the next grepped for string ever ever determined?

$ grep -nr semantion cli
cli/NEWS.md:238:* cli now handles quotes and comment characters better in the semantion
$ 

Character
absolute
alloced
beginning
calculate
calculate
characters
characters
coerced
comparison
configuration
explicitly
expression
highlighted
inherited
inline
newlines
overview
priority
releases
separator
separate
terminal

$ grep -nr Charcater cli
cli/R/ansiex.R:1123:#' @param x Charcater vector. Other objects are coarced using
cli/man/ansi_nzchar.Rd:10:\item{x}{Charcater vector. Other objects are coarced using
$ grep -nr aboslute cli
cli/R/cliapp-docs.R:543:#' convert relative paths, and paths starting with `~` to aboslute path.
cli/man/links.Rd:146:convert relative paths, and paths starting with \code{~} to aboslute path.
$ grep -nr alloaced cli
cli/src/vt.c:816:    R_THROW_ERROR("Internal vt error, OSC buffer not alloaced");
cli/src/vt.c:849:    R_THROW_ERROR("Internal vt error, OSC buffer not alloaced");
$ grep -nr begnning cli
cli/R/ansiex.R:575:      # But (except for the begnning) we need one less empty lines than
$ grep -nr caculate cli
cli/R/hash.R:571:#' @details The `64` functions caculate the 64 bit variant
cli/man/hash_xxhash.Rd:64:The \code{64} functions caculate the 64 bit variant
$ grep -nr calculae cli
cli/R/diff.R:188:    # calculae the end before updating the begin
$ grep -nr characaters cli
cli/tests/testthat/_snaps/keypress.md:1:# control characaters
cli/tests/testthat/test-keypress.R:1:test_that("control characaters", {
$ grep -nr charadcters cli
cli/R/ansiex.R:396:# TODO: show wide Unicode charadcters, once they work in asciicast
$ grep -nr coarced cli
cli/R/ansiex.R:1123:#' @param x Charcater vector. Other objects are coarced using
cli/man/ansi_nzchar.Rd:10:\item{x}{Charcater vector. Other objects are coarced using
$ grep -nr comparision cli
cli/R/utf8.R:49:#' # For comparision, the output for width depends on the R version used:
cli/man/utf8_nchar.Rd:38:# For comparision, the output for width depends on the R version used:
$ grep -nr configuation cli
cli/src/progress.c:207:    error("Unknown cli progress bar configuation, see manual.");
cli/tests/testthat/_snaps/progress-c.md:40:      ! Unknown cli progress bar configuation, see manual.
$ grep -nr explicity cli
cli/tools/get-rstudio-themes.R:44:## We need to explicity set themes that should be overridden with the default
$ grep -nr expresssion cli
cli/tests/testthat/test-inline-2.R:156:test_that_cli(configs = "ansi", "brace expresssion edge cases", {
cli/tests/testthat/_snaps/inline-2.md:362:# brace expresssion edge cases [ansi]
$ grep -nr highlightedm cli
cli/R/errors.R:831:  # - the call, possibly syntax highlightedm possibly trimmed (?)
$ grep -nr interited cli
cli/R/inline.R:77:#' * While making sure that the inlide style's non-interited style is
$ grep -nr inlide cli
cli/R/inline.R:77:#' * While making sure that the inlide style's non-interited style is
$ grep -nr newlinees cli
cli/NEWS.md:150:  They also keep multiple consecutive `\f` as multiple newlinees (#491).
$ grep -nr overiew cli
cli/_pkgdown.yml:189:    article for a quick overiew of most of them.
$ grep -nr priotity cli
cli/R/width.R:34:  # cli.width option always takes priotity
$ grep -nr relaases cli
cli/inst/examples/apps/news.R:100:  --week        Show relaases in the last 7 * 24 hours
cli/exec/news.R:100:  --week        Show relaases in the last 7 * 24 hours
$ grep -nr separater cli
cli/R/vt.R:24:#' collapsed (without a separater), and converted to a raw vector using
cli/man/vt_output.Rd:11:collapsed (without a separater), and converted to a raw vector using
$ grep -nr seperate cli
cli/NEWS.md:53:* `ansi_collapse()` gains a `sep2` argument to specify a seperate separator
$ grep -nr temrinal cli
cli/R/vt.R:32:#' This function is experimental, and the virtual temrinal API will
cli/man/vt_output.Rd:47:This function is experimental, and the virtual temrinal API will
$ 

GNU sed commands

sed -i "s/Charcater/Character/g" cli/R/ansiex.R
sed -i "s/aboslute/absolute/g" cli/R/cliapp-docs.R
sed -i "s/alloaced/alloced/g" cli/src/vt.c
sed -i "s/begnning/beginning/g" cli/R/ansiex.R
sed -i "s/caculate/calculate/g" cli/R/hash.R
sed -i "s/calculae/calculate/g" cli/R/diff.R
# sed -i "s/characaters/characters/g" cli/tests/testthat/test-keypress.R
# sed -i "s/characaters/characters/g" cli/tests/testthat/_snaps/keypress.md
sed -i "s/charadcters/characters/g" cli/R/ansiex.R
sed -i "s/coarced/coerced/g" cli/R/ansiex.R
sed -i "s/comparision/comparison/g" cli/R/utf8.R
sed -i "s/configuation/configuration/g" cli/src/progress.c
# sed -i "s/configuation/configuration/g" cli/tests/testthat/_snaps/progress-c.md
sed -i "s/explicity/explicitly/g" cli/tools/get-rstudio-themes.R
# sed -i "s/expresssion/expression/g" cli/tests/testthat/test-inline-2.R
# sed -i "s/expresssion/expression/g" cli/tests/testthat/_snaps/inline-2.md
sed -i "s/highlightedm/highlighted/g" cli/R/errors.R
sed -i "s/interited/inherited/g" cli/R/inline.R
sed -i "s/inlide/inline/g" cli/R/inline.R
sed -i "s/newlinees/newlines/g" cli/NEWS.md
sed -i "s/overiew/overview/g" cli/_pkgdown.yml
sed -i "s/priotity/priority/g" cli/R/width.R
sed -i "s/relaases/releases/g" cli/inst/examples/apps/news.R
sed -i "s/separater/separator/g" cli/R/vt.R
sed -i "s/seperate/separate/g" cli/NEWS.md
sed -i "s/temrinal/terminal/g" cli/R/vt.R

[gaborcsardi]

I am sorry, I am not sure what you are asking for here. roxygen2::roxygenise() works for me on main, with the dev version of roxygen2 (haven't tried other versions).

You can submit a PR of corrections without running roxygen2, that's completely fine.

[musvaage]

roxygen2::roxygenise()

my roxygen2 version is 7.3.2

submit a PR

manual fixes seem approved as per the last comment

therefore these changes were added as affecting files in the tests subdirectory

# sed -i "s/characaters/characters/g" cli/tests/testthat/test-keypress.R
# sed -i "s/characaters/characters/g" cli/tests/testthat/_snaps/keypress.md
# sed -i "s/configuation/configuration/g" cli/tests/testthat/_snaps/progress-c.md
# sed -i "s/expresssion/expression/g" cli/tests/testthat/test-inline-2.R
# sed -i "s/expresssion/expression/g" cli/tests/testthat/_snaps/inline-2.md

[musvaage]

my roxygen2 version is 7.3.2

@gaborcsardi

running roxygen2::roxygenise() to regenerate the relevant .Rd files

This is left for someone else to sort out.

✖ cliapp-docs.R:179: @section has mismatched braces or quotes.
Error in collapse(c(x$value$title, y$value$title), c(x$value$content,  : 
  length(key) == length(value) is not TRUE
In addition: Warning message:
Failed to source `man/roxygen/meta.R` 

[gaborcsardi]

This is left for someone else to sort out.

That's fine, no worries.