Examples for outer_negation_linter() and object_usage_linter()

R/object_usage_linter.R

@@ -9,6 +9,23 @@
 #'   will be skipped. This argument will be passed to `skipWith` argument of
 #'   `codetools::checkUsage()`.
 #'
+#' @examples
+#' # will produce lints
+#' lint(
+#'   text = "foo <- function() { x <- 1 }",
+#'   linters = object_usage_linter()
+#' )
+#'
+#' # okay
+#' lint(
+#'   text = "foo <- function(x) { x <- 1 }",
+#'   linters = object_usage_linter()
+#' )
+#'
+#' lint(
+#'   text = "foo <- function() { x <- 1; return(x) }",
+#'   linters = object_usage_linter()
+#' )
 #' @evalRd rd_linters("package_development")
 #' @seealso [linters] for a complete list of linters available in lintr.
 #' @export

R/outer_negation_linter.R

@@ -4,6 +4,29 @@
 #'   `all(!x)` and `!any(x)`. Negating after aggregation only requires inverting
 #'   one logical value, and is typically more readable.
 #'
+#' @examples
+#' # will produce lints
+#' lint(
+#'   text = "all(!x)",
+#'   linters = outer_negation_linter()
+#' )
+#'
+#' lint(
+#'   text = "any(!x)",
+#'   linters = outer_negation_linter()
+#' )
+#'
+#' # okay
+#' lint(
+#'   text = "!any(x)",
+#'   linters = outer_negation_linter()
+#' )
+#'
+#' lint(
+#'   text = "!all(x)",
+#'   linters = outer_negation_linter()
+#' )
+#'
 #' @evalRd rd_tags("outer_negation_linter")
 #' @seealso [linters] for a complete list of linters available in lintr.
 #' @export

tests/testthat/test-outer_negation_linter.R

@@ -1,18 +1,20 @@
 test_that("outer_negation_linter skips allowed usages", {
-  expect_lint("x <- any(y)", NULL, outer_negation_linter())
-  expect_lint("y <- all(z)", NULL, outer_negation_linter())
+  linter <- outer_negation_linter()
+
+  expect_lint("x <- any(y)", NULL, linter)
+  expect_lint("y <- all(z)", NULL, linter)
 
   # extended usage of any is not covered
-  expect_lint("any(!a & b)", NULL, outer_negation_linter())
-  expect_lint("all(a | !b)", NULL, outer_negation_linter())
+  expect_lint("any(!a & b)", NULL, linter)
+  expect_lint("all(a | !b)", NULL, linter)
 
-  expect_lint("any(a, b)", NULL, outer_negation_linter())
-  expect_lint("all(b, c)", NULL, outer_negation_linter())
-  expect_lint("any(!a, b)", NULL, outer_negation_linter())
-  expect_lint("all(a, !b)", NULL, outer_negation_linter())
-  expect_lint("any(a, !b, na.rm = TRUE)", NULL, outer_negation_linter())
+  expect_lint("any(a, b)", NULL, linter)
+  expect_lint("all(b, c)", NULL, linter)
+  expect_lint("any(!a, b)", NULL, linter)
+  expect_lint("all(a, !b)", NULL, linter)
+  expect_lint("any(a, !b, na.rm = TRUE)", NULL, linter)
   # ditto when na.rm is passed quoted
-  expect_lint("any(a, !b, 'na.rm' = TRUE)", NULL, outer_negation_linter())
+  expect_lint("any(a, !b, 'na.rm' = TRUE)", NULL, linter)
 })
 
 test_that("outer_negation_linter blocks simple disallowed usages", {