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

Be less aggressive about documenting in check() #2263

Closed
hadley opened this issue Aug 1, 2020 · 3 comments · Fixed by #2274
Closed

Be less aggressive about documenting in check() #2263

hadley opened this issue Aug 1, 2020 · 3 comments · Fixed by #2274

Comments

@hadley
Copy link
Member

hadley commented Aug 1, 2020

Not sure how to detect this, but when you’re doing a PR to someone else’s repo, it’s annoying that check documents and introduces a bunch of spurious changes.

Maybe a reasonable heuristic is to only rebuild if roxygen version is the same, otherwise emit a very clear warning.

@jimhester
Copy link
Member

I really think it would be better to not run document() by default in check() at all, but I know you disagree.

@hadley
Copy link
Member Author

hadley commented Aug 3, 2020

I think I agree that we shouldn’t have done this in the first place. But I’m concerned that if we change it now it’s going to cause a lot of unpleasant surprises for people so we need to figure out some compromise position.

@jimhester
Copy link
Member

I think your idea of only rebuilding if the roxygen version matches is a good compromise.

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 a pull request may close this issue.

2 participants