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

avoid unnecessary calls to roxygen2::roxygenize() #151

Merged
merged 8 commits into from Apr 12, 2020
Merged

Conversation

lorenzwalthert
Copy link
Owner

@lorenzwalthert lorenzwalthert commented Apr 12, 2020

Idea: use {git2r} to check if diff includes roxygen2 comments. This will make the hook pass for all edits that don't involve roxygen comments in R/ and hence bring a big speedup in a typical workflow as the roxygen hook is quite expensive to run. And we have really good testing too of the core functionality.
Closes #145.

@codecov-io
Copy link

codecov-io commented Apr 12, 2020

Codecov Report

Merging #151 into master will increase coverage by 1.44%.
The diff coverage is 95.23%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #151      +/-   ##
==========================================
+ Coverage   64.91%   66.36%   +1.44%     
==========================================
  Files          11       12       +1     
  Lines         419      440      +21     
==========================================
+ Hits          272      292      +20     
- Misses        147      148       +1     
Impacted Files Coverage Δ
R/roxygen2.R 95.00% <95.00%> (ø)
R/utils.R 88.88% <100.00%> (+0.65%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 4175e49...fbf7e6c. Read the comment docs.

@lorenzwalthert lorenzwalthert merged commit c679a1d into master Apr 12, 2020
@lorenzwalthert lorenzwalthert deleted the issue-145 branch April 12, 2020 21:46
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.

speedup roxygen2 hook by checking if it has to run at all
2 participants