Open Shoeboxam opened 4 months ago
Which lines of the GHA log are you referring to?
I don't see any warnings, just NOTES:
0 errors ✔ | 0 warnings ✔ | 3 notes ✖
https://github.com/opendp/opendp/actions/runs/7904579655/job/21575444021?pr=1253#step:8:154
Hi Jenny, thanks for the response! This part here located at the top of the log:
Registered S3 method overwritten by 'opendp':
method from
print.hashtab utils
✖ mod.R:390: S3 method `to_str.default` needs @export or @exportS3method tag.
✖ mod.R:391: S3 method `to_str.hashtab` needs @export or @exportS3method tag.
I think these warnings somehow got missed?
The three notes seem to be for other, unrelated things.
error_on
has a very specific sphere of influence and it's narrower than what you seem to be expecting:
Whether to throw an error on
R CMD check
failures....
There has been other confusion about error_on
(#2506) and, as a result, the documentation of devtools::check(error_on =)
in the dev version of devtools is different (hopefully better).
https://devtools.r-lib.org/dev/reference/check.html#arguments
The primary intent of check()
really is to show you what R CMD check
would see, if it were run by, say, CRAN. The optional execution of document()
is really a convenience or courtesy for interactive development. I'd say the devtools workflow assumes you are also running document()
by itself fairly frequently, which will also surface these items for attention.
Do you have anything to add or a different take @gaborcsardi or @hadley? I do note that this pertains to relatively new opinions expressed by roxygen2.
I'm surprised to see the devtools check command pass when configured to error on warnings, and then still see warnings in the build output.
For example, see the start of the
check
step here: https://github.com/opendp/opendp/actions/runs/7904579655/job/21575444021?pr=1253Is it possible to configure devtools to include warnings from documenting?
Thanks!