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

Improve error message in namespace_linter() #1844

Merged
merged 5 commits into from
Dec 17, 2022
Merged

Conversation

IndrajeetPatil
Copy link
Collaborator

Specifically, mention where to create issue if the linter fails.

Specifically, mention where to create issue if the linter fails.
@codecov-commenter
Copy link

Codecov Report

Merging #1844 (ec2ee49) into main (becdbac) will increase coverage by 0.00%.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##             main    #1844   +/-   ##
=======================================
  Coverage   98.85%   98.85%           
=======================================
  Files         112      112           
  Lines        4816     4818    +2     
=======================================
+ Hits         4761     4763    +2     
  Misses         55       55           
Impacted Files Coverage Δ
R/namespace_linter.R 100.00% <100.00%> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

R/namespace_linter.R Outdated Show resolved Hide resolved
if (any(failed_namespace)) {
stop("Failed to retrieve namespaces for one or more of the packages. Please report this issue.") # nocov
stop(
"Failed to retrieve namespaces for one or more of the packages. ",
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's improve this message too while we're at it -- "the packages" is a bit vague, what packages?

We could either describe it generally "one or more of the packages used with :: or :::", or more specifically by actually naming the packages.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For now, I have just included the generic message.

I have created a new issue (#1855) to remember to improve the message by including problematic package names, since it isn't as trivial as I thought, and don't want to expand the scope of this PR beyond what I originally had in mind.

Copy link
Collaborator

@MichaelChirico MichaelChirico left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks!

@MichaelChirico MichaelChirico merged commit c3ec3a1 into main Dec 17, 2022
@MichaelChirico MichaelChirico deleted the error_msg_ns_linter branch December 17, 2022 17:26
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.

3 participants