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

Jump to bottom

Document "symbols" naming style in object_name_linter #1924

Closed
hedsnz opened this issue Feb 28, 2023 · 2 comments · Fixed by #2001
Closed

Document "symbols" naming style in object_name_linter #1924

hedsnz opened this issue Feb 28, 2023 · 2 comments · Fixed by #2001
Labels
documentation

Comments

@hedsnz
Copy link
Contributor

hedsnz commented Feb 28, 2023

The documentation for object_name_linter describes:

... The default naming styles are "snake_case" and "symbols".

After that, there is no explanation of what "symbols" means, and there is no example that uses styles = "symbols". Could this documentation please be added?

Thanks
@luma-sb
Copy link

luma-sb commented Jun 14, 2023

I was recently asked by my team what the "symbols" style for object_name_linter linter did - so did some digging and hit same issue as you @hedsnz . Appears this was introduced to resolve issue #615 which provides helpful examples to demonstrate applicable cases.

@AshesITR
Copy link
Collaborator

AshesITR commented Jul 1, 2023

Not sure where to document the regexes, but I would describe "symbols" as function names containing only non-alphanumeric characters, e.g., `%+%` from ggplot2 or `%>%` from magrittr.

@hedsnz hedsnz mentioned this issue Jul 5, 2023
Closed
hedsnz added a commit to hedsnz/lintr that referenced this issue Jul 5, 2023
@hedsnz
document "symbols" in object_name_linter (r-lib#1924)
3b03bc9
@hedsnz hedsnz mentioned this issue Jul 5, 2023
Merged
MichaelChirico pushed a commit that referenced this issue Jul 7, 2023
@hedsnz
document "symbols" in object_name_linter (#1924) (#2001)
daaa3a4 
* document "symbols" in object_name_linter (#1924)

* further clarify symbols

* update wording on object_name_linter

* update wording of symbols documentation
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

document "symbols" in object_name_linter (#1924) hedsnz/lintr
4 participants
@AshesITR @IndrajeetPatil @hedsnz @luma-sb