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

error message doesn't reveal problem, only solution #77

Closed
ElsLommelen opened this issue Jan 13, 2022 · 2 comments
Closed

error message doesn't reveal problem, only solution #77

ElsLommelen opened this issue Jan 13, 2022 · 2 comments
Labels
enhancement New feature or request help wanted Extra attention is needed

Comments

@ElsLommelen
Copy link
Contributor

Here I describe an error that is unclear to me: it suggests to run devtools::document() and push an updated version of NAMESPACE, but running this command locally doesn't generate a new version of the NAMESPACE file. And the logging doesn't give the slightest hint on what has been tested, and what could be wrong there.

I like the fact that checklist errors always explain clearly what has to be done, and mostly this works fine. But in the few cases where it doesn't (often due to a different behaviour in different OS), I think it is a drawback that even in the logging it is unclear what causes the error. Would it be a possibility that for instance in this case, the differences between the NAMESPACE files, or even just both versions of the file, could be added to the logging? And more generally: could some more outputs be generated in the logging for the checklist specific tests?

@ThierryO ThierryO added enhancement New feature or request help wanted Extra attention is needed labels Jan 19, 2022
@ThierryO
Copy link
Collaborator

Would adding a git diff to the error message a solution?

@ElsLommelen
Copy link
Contributor Author

Yes, sounds like a perfect solution.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants