Skip to content

Commit 246b4f1

Browse files
committed
fix documentation
1 parent bccf595 commit 246b4f1

File tree

2 files changed

+8
-4
lines changed

2 files changed

+8
-4
lines changed

R/object_name_linter.R

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@ object_name_xpath <- local({
2424
#' Check that object names conform to a naming style.
2525
#' The default naming styles are "snake_case" and "symbols".
2626
#'
27+
#' Quotes (`` `"' ``) and specials (`%` and trailing `<-`) are not considered part of the object name.
28+
#'
2729
#' Note when used in a package, in order to ignore objects imported
2830
#' from other namespaces, this linter will attempt [getNamespaceExports()]
2931
#' whenever an `import(PKG)` or `importFrom(PKG, ...)` statement is found
@@ -45,8 +47,8 @@ object_name_xpath <- local({
4547
#' \Sexpr[stage=render, results=rd]{lintr:::regexes_rd}. A name should
4648
#' match at least one of these styles.
4749
#' @param regexes A (possibly named) character vector specifying a custom naming convention.
48-
#' If named, the names will be used in the lint message. Otherwise, "custom" will be used as a name for the style.
49-
#' Quotes (`` `"' ``) and specials (`%` and trailing `<-`) are not considered part of the name to be matched.
50+
#' If named, the names will be used in the lint message. Otherwise, the regexes enclosed by `/` will be used in the
51+
#' lint message.
5052
#' Note that specifying `regexes` overrides the default `styles`. So if you want to combine `regexes` and `styles`,
5153
#' both need to be explicitly specified.
5254
#'

man/object_name_linter.Rd

Lines changed: 4 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)