Improve str_detect documentation (#496)

Fixes #489
tidyverse · Jan 19, 2023 · 65b218e · 65b218e
1 parent 7413003
commit 65b218e
Show file tree

Hide file tree

Showing 5 changed files with 5 additions and 5 deletions.
diff --git a/R/detect.R b/R/detect.R
@@ -21,7 +21,7 @@
 #'   [boundary()]. An empty pattern, "", is equivalent to
 #'   `boundary("character")`.
 #'
-#' @param negate If `TRUE`, return non-matching elements.
+#' @param negate If `TRUE`, inverts the resulting boolean vector.
 #' @return A logical vector the same length as `string`/`pattern`.
 #' @seealso [stringi::stri_detect()] which this function wraps,
 #'   [str_subset()] for a convenient wrapper around

diff --git a/man/str_detect.Rd b/man/str_detect.Rd
diff --git a/man/str_starts.Rd b/man/str_starts.Rd
diff --git a/man/str_subset.Rd b/man/str_subset.Rd
diff --git a/man/str_which.Rd b/man/str_which.Rd