search

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

Documentation of `check_dir` #185

Closed fweber144 closed 2 years ago

fweber144 commented 2 years ago

This fixes the documentation for argument check_dir of rcmdcheck(), see r-lib/devtools#2455.

fweber144 commented 2 years ago

Note: I have not run R CMD check on the rcmdcheck package as modified by this PR.

EDIT: GitHub Actions does the job, it just took some time to show up here.

codecov-commenter commented 2 years ago

Codecov Report

Merging #185 (ac7a047) into main (bda6e71) will not change coverage. The diff coverage is n/a.

:exclamation: Current head ac7a047 differs from pull request most recent head 6eeca54. Consider uploading reports for the commit 6eeca54 to get more accurate results

@@           Coverage Diff           @@
##             main     #185   +/-   ##
=======================================
  Coverage   80.63%   80.63%           
=======================================
  Files          19       19           
  Lines        1007     1007           
=======================================
  Hits          812      812           
  Misses        195      195
Impacted Files Coverage Δ
R/package.R 87.09% <ø> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

gaborcsardi commented 2 years ago

Why do you want to change this?

fweber144 commented 2 years ago

Because of https://github.com/r-lib/devtools/pull/2455, in particular https://github.com/r-lib/devtools/pull/2455#discussion_r940888612 which is what commit 6d1fb50 is for. The garbage collection part that commit ac7a047 changes might indeed have been correct; I'm not too familiar with garbage collection. In any case, I think the new wording from commit ac7a047 is easier to understand for most R users.

jennybc commented 2 years ago

I tweaked this and re-document()-ed and will merge it @gaborcsardi. This all started due to a devtools issue (linked above), the result of which is that devtools is going to inherit the documentation for check_dir.

(Based on what I learned from this, I think devtools should not set a default value for check_dir, so I'll likely make that change there.)