Stop the lago_report() example from hanging the pkgdown build - #92
Merged
Merged
Conversation
The lago_report() example was wrapped in \donttest, and lago_report() renders an HTML file with rmarkdown. pkgdown runs \donttest examples in-process (build_site_github_pages(new_process = FALSE)), and a document render nested inside pkgdown's own knitr session deadlocks, which left the pkgdown job running for hours. R CMD check --as-cran runs the same example without hanging because its render happens in a separate context. Wrap the example in \dontrun instead, matching visualize_cost(): a function that writes a file and invokes pandoc should not auto-run during a check or an in-process docs build. Regenerates man/lago_report.Rd.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What this changes
\donttestandlago_report()renders an HTML file withrmarkdown. pkgdownruns
\donttestexamples in-process (build_site_github_pages(new_process = FALSE)), and a nested document render inside pkgdown's own knitr sessiondeadlocks. Wraps the example in
\dontruninstead (matchingvisualize_cost()),so pkgdown skips it;
R CMD check --as-cranwas unaffected either way.Regenerates
man/lago_report.Rd.Related issue
Closes #
Checklist
tests/testthat/— n/a, example/doc change, no code behavior changedevtools::document()run (regeneratedman/lago_report.Rd)devtools::check()passes locally — unaffected (example runs identically under check)NEWS.mdupdated — n/a, fixes a docs-build issue, not user-facing package behavior