r-lib / rcmdcheck

Run R CMD check from R and collect the results
https://rcmdcheck.r-lib.org
Other
115 stars 27 forks source link

typos #204

Closed musvaage closed 10 months ago

musvaage commented 1 year ago

accessible configuration programmatically warnings

$ grep -nr accesible rcmdcheck
rcmdcheck/tests/testthat/test-parse.R:32:  expect_match(check$test_fail[[1]], "BSDR API accesible")
rcmdcheck/tests/testthat/dataonderivatives-test/00check.log:61:  1. Failure: BSDR API accesible (@test-bsdr.R#6)
rcmdcheck/tests/testthat/dataonderivatives-test/00check.log:62:  2. Failure: BSDR API accesible (@test-bsdr.R#8)
rcmdcheck/tests/testthat/dataonderivatives-test/00check.log:63:  3. Failure: BSDR API accesible (@test-bsdr.R#9)
rcmdcheck/tests/testthat/dataonderivatives-test/tests/testthat.Rout.fail:22:1. Failure: BSDR API accesible (@test-bsdr.R#6) --------------------------------
rcmdcheck/tests/testthat/dataonderivatives-test/tests/testthat.Rout.fail:26:2. Failure: BSDR API accesible (@test-bsdr.R#8) --------------------------------
rcmdcheck/tests/testthat/dataonderivatives-test/tests/testthat.Rout.fail:30:3. Failure: BSDR API accesible (@test-bsdr.R#9) --------------------------------
rcmdcheck/tests/testthat/dataonderivatives-test/tests/testthat.Rout.fail:40:1. Failure: BSDR API accesible (@test-bsdr.R#6)
rcmdcheck/tests/testthat/dataonderivatives-test/tests/testthat.Rout.fail:41:2. Failure: BSDR API accesible (@test-bsdr.R#8)
rcmdcheck/tests/testthat/dataonderivatives-test/tests/testthat.Rout.fail:42:3. Failure: BSDR API accesible (@test-bsdr.R#9)
rcmdcheck/tests/testthat/_snaps/parse.md:138:      1. Failure: BSDR API accesible (@test-bsdr.R#6) --------------------------------
rcmdcheck/tests/testthat/_snaps/parse.md:142:      2. Failure: BSDR API accesible (@test-bsdr.R#8) --------------------------------
rcmdcheck/tests/testthat/_snaps/parse.md:146:      3. Failure: BSDR API accesible (@test-bsdr.R#9) --------------------------------
rcmdcheck/tests/testthat/_snaps/parse.md:156:      1. Failure: BSDR API accesible (@test-bsdr.R#6)
rcmdcheck/tests/testthat/_snaps/parse.md:157:      2. Failure: BSDR API accesible (@test-bsdr.R#8)
rcmdcheck/tests/testthat/_snaps/parse.md:158:      3. Failure: BSDR API accesible (@test-bsdr.R#9)
rcmdcheck/tests/testthat/_snaps/parse.md:187:      1. Failure: BSDR API accesible (@test-bsdr.R#6) --------------------------------
rcmdcheck/tests/testthat/_snaps/parse.md:191:      2. Failure: BSDR API accesible (@test-bsdr.R#8) --------------------------------
rcmdcheck/tests/testthat/_snaps/parse.md:195:      3. Failure: BSDR API accesible (@test-bsdr.R#9) --------------------------------
rcmdcheck/tests/testthat/_snaps/parse.md:205:      1. Failure: BSDR API accesible (@test-bsdr.R#6)
rcmdcheck/tests/testthat/_snaps/parse.md:206:      2. Failure: BSDR API accesible (@test-bsdr.R#8)
rcmdcheck/tests/testthat/_snaps/parse.md:207:      3. Failure: BSDR API accesible (@test-bsdr.R#9)
rcmdcheck/tests/testthat/_snaps/parse.md:236:      1. Failure: BSDR API accesible (@test-bsdr.R#6) --------------------------------
rcmdcheck/tests/testthat/_snaps/parse.md:240:      2. Failure: BSDR API accesible (@test-bsdr.R#8) --------------------------------
rcmdcheck/tests/testthat/_snaps/parse.md:244:      3. Failure: BSDR API accesible (@test-bsdr.R#9) --------------------------------
rcmdcheck/tests/testthat/_snaps/parse.md:254:      1. Failure: BSDR API accesible (@test-bsdr.R#6)
rcmdcheck/tests/testthat/_snaps/parse.md:255:      2. Failure: BSDR API accesible (@test-bsdr.R#8)
rcmdcheck/tests/testthat/_snaps/parse.md:256:      3. Failure: BSDR API accesible (@test-bsdr.R#9)
rcmdcheck/tests/testthat/_snaps/parse.md:285:      1. Failure: BSDR API accesible (@test-bsdr.R#6) --------------------------------
rcmdcheck/tests/testthat/_snaps/parse.md:289:      2. Failure: BSDR API accesible (@test-bsdr.R#8) --------------------------------
rcmdcheck/tests/testthat/_snaps/parse.md:293:      3. Failure: BSDR API accesible (@test-bsdr.R#9) --------------------------------
rcmdcheck/tests/testthat/_snaps/parse.md:303:      1. Failure: BSDR API accesible (@test-bsdr.R#6)
rcmdcheck/tests/testthat/_snaps/parse.md:304:      2. Failure: BSDR API accesible (@test-bsdr.R#8)
rcmdcheck/tests/testthat/_snaps/parse.md:305:      3. Failure: BSDR API accesible (@test-bsdr.R#9)
$ grep -nr configration rcmdcheck
rcmdcheck/R/options.R:11:#' Package configration is defined in the `DESCRIPTION` file of the checked
rcmdcheck/man/rcmdcheck-config.Rd:15:Package configration is defined in the \code{DESCRIPTION} file of the checked
$ grep -nr programatically rcmdcheck
rcmdcheck/tests/testthat/fixtures/checks/comparing.txt:60:< programatically   NEWS.md:14
rcmdcheck/tests/testthat/_snaps/callback.md:396:      [10] "\r  \r   < programatically   NEWS.md:14"
rcmdcheck/tests/testthat/_snaps/callback.md:521:      [60] "< programatically   NEWS.md:14"
$ grep -nr warnnigs rcmdcheck
rcmdcheck/R/background.R:47:#' fields `errors`, `warnnigs` and `notes`, just like [rcmdcheck()]. It
rcmdcheck/man/rcmdcheck_process.Rd:57:fields \code{errors}, \code{warnnigs} and \code{notes}, just like \code{\link[=rcmdcheck]{rcmdcheck()}}. It
$

unclear how to proceed with replacing the string accesible appearing as it does in multiple files

tests/testthat/_snaps/parse.md

this file contains ANSI escape sequences for colourising output

the appearance of colourised output of course doesn't appear when the .md file from the repo is viewed in a browser

R/*.R

if those files are edited the corresponding man/*.Rd files should be regenerated

musvaage commented 1 year ago

@gaborcsardi

Are you OK with implementing these instead of letting running tests update the tests/testthat/_snaps/*.md files?

sed -i "s/accesible/accessible/g" rcmdcheck/tests/testthat/test-parse.R
sed -i "s/accesible/accessible/g" rcmdcheck/tests/testthat/dataonderivatives-test/00check.log
sed -i "s/accesible/accessible/g" rcmdcheck/tests/testthat/dataonderivatives-test/tests/testthat.Rout.fail
sed -i "s/accesible/accessible/g" rcmdcheck/tests/testthat/_snaps/parse.md
sed -i "s/programatically/programmatically/g" rcmdcheck/tests/testthat/fixtures/checks/comparing.txt
sed -i "s/programatically/programmatically/g" rcmdcheck/tests/testthat/_snaps/callback.md

portability note

sed -i <pattern> fails on macosx and bsd where you should use sed -ie <pattern>


configuration warnings

there would remain these R/*.R file typos which if fixed would oblige regenerating the relevant man/*.Rd files

musvaage commented 10 months ago

the DESCRIPTION file was modified upstream subsequent to submitting this ticket's related pull

the change to the DESCRIPTION file was reverted where it was considered that a rebase could be pursued

however after that second commit to my fork other unnamed files were then showing up as conflicting