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.

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

Conversation

hedsnz
Copy link
Contributor

@hedsnz hedsnz commented Jul 5, 2023

Resolves #1924 by adding a short description of the "symbols" style in the object_name_linter documentation.

@codecov-commenter
Copy link

codecov-commenter commented Jul 5, 2023

Codecov Report

Merging #2001 (6d67158) into main (ba896ef) will not change coverage.
The diff coverage is n/a.

❗ Current head 6d67158 differs from pull request most recent head 46d7163. Consider uploading reports for the commit 46d7163 to get more accurate results

@@           Coverage Diff           @@
##             main    #2001   +/-   ##
=======================================
  Coverage   98.56%   98.56%           
=======================================
  Files         113      113           
  Lines        5003     5003           
=======================================
  Hits         4931     4931           
  Misses         72       72           
Impacted Files Coverage Δ
R/object_name_linter.R 98.18% <ø> (ø)

R/object_name_linter.R Outdated Show resolved Hide resolved
@MichaelChirico
Copy link
Collaborator

Thanks for your patience -- a long review for a seemingly minor change :)

But it's important to get user-facing docs as nice as possible, IMO.

Please also credit yourself in the NEWS! I think this would be most appropriate in the Notes section.

@hedsnz
Copy link
Contributor Author

hedsnz commented Jul 7, 2023

I'm very much in agreement :)

Thanks!

edit -- I'm assuming you will squash commits via the pull request and don't need me to force push a squashed history?

@MichaelChirico MichaelChirico merged commit daaa3a4 into r-lib:main Jul 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document "symbols" naming style in object_name_linter
4 participants