Add examples to documentation: Part-5 (l-n) #1655
Conversation
Codecov Report
@@ Coverage Diff @@
## main #1655 +/- ##
=======================================
Coverage 98.49% 98.49%
=======================================
Files 101 101
Lines 4456 4456
=======================================
Hits 4389 4389
Misses 67 67
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
| #' lint( | ||
| #' text = "mean(x, )", | ||
| #' linters = missing_argument_linter(allow_trailing = TRUE) | ||
| #' ) |
There was a problem hiding this comment.
not a good example I think, since this may be erroneous to use. better to use a list2() example, maybe filter() or tibble() or mutate(), to demonstrate a case where the lint is more subjective as opposed to avoiding errors
There was a problem hiding this comment.
I have changed the example, but still wanted to understand your comment.
Under what circumstances will this be the case?
this may be erroneous to use
x <- c(1, 2, 3)
mean(x, )
#> [1] 2Created on 2022-10-10 with reprex v2.0.2
There was a problem hiding this comment.
You're right, I was speaking a bit more generally (hadn't check if mean(x, ) works)... point being it's very hard to tell at a glance whether code like that will run or not (and hence a lint is really good), whereas I think allow_trailing=TRUE is intended to allow a common source of false positives through (namely, list2() usages)
R/missing_package_linter.R
Outdated
| #' @examples | ||
| #' # will produce lints | ||
| #' lint( | ||
| #' text = "library(statts)", |
There was a problem hiding this comment.
I worry statts is too close to something that could conceivably be a real package name (if not now, then eventually). maybe pick something more obscure?
There was a problem hiding this comment.
Can't think of something that I don't see being a package name, so chose xyzxyz. Happy to change if you can think of something better.
There was a problem hiding this comment.
SGTM, I also think a gibberish name is OK...
Except
nonportable_path_linter(); I will come back to it later.Part of #1492