Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

document "symbols" in object_name_linter (#1924) #2001

Merged
merged 4 commits into from
Jul 7, 2023
Merged

document "symbols" in object_name_linter (#1924) #2001

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3b03bc9
document "symbols" in object_name_linter (#1924)
hedsnz Jul 5, 2023
521f248
further clarify symbols
hedsnz Jul 5, 2023
0d80cc6
update wording on object_name_linter
hedsnz Jul 6, 2023
46d7163
update wording of symbols documentation
hedsnz Jul 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion R/object_name_linter.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,11 @@ object_name_xpath <- local({
#'
#' @param styles A subset of
#' \Sexpr[stage=render, results=rd]{lintr:::regexes_rd}. A name should
#' match at least one of these styles.
#' match at least one of these styles. The `"symbols"` style refers to
#' names containing *only* non-alphanumeric characters; e.g., `%+%` from
#' ggplot2 or `%>%` from magrittr will not generate lint markers, whereas
hedsnz marked this conversation as resolved.
Show resolved Hide resolved
#' `%in%` (containing both alphanumeric *and* non-alphanumeric characters)
hedsnz marked this conversation as resolved.
Show resolved Hide resolved
#' will.
#' @param regexes A (possibly named) character vector specifying a custom naming convention.
#' If named, the names will be used in the lint message. Otherwise, the regexes enclosed by `/` will be used in the
#' lint message.
Expand Down
6 changes: 5 additions & 1 deletion man/object_name_linter.Rd
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.