docs: unwrap \donttest{} on the five core help pages (PUNY-zumspyzy) - #97
Merged
Merged
Conversation
puny_encode, puny_decode, is_punycode, is_idn and validate_domain wrapped
their entire \examples{} block in \donttest{}, so a default R CMD check
never executed the examples for the package's primary surface -- only 3 of
8 help pages ran.
Every one of these examples is a fast, offline, deterministic call on a
string constant: no network, no filesystem, no timing or platform
dependence. Unwrapping them means CRAN verifies these pages on every
platform it checks, including the Windows fallback-backend path that
configure never exercises locally.
Regenerated man/ with roxygen2. R CMD check --as-cran without
--run-donttest: "checking examples ... OK", 1 NOTE (the pre-existing dev
version string). Slowest example is 2ms.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
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
2 participants
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.
All five core help pages —
puny_encode,puny_decode,is_punycode,is_idn,validate_domain— wrapped their entire\examples{}block in\donttest{}.R CMD checkskips those by default, so CRAN never executed the examples for the package's primary surface: 8 exports have examples, but only 3 help pages ran under a default check.Every one of these examples is a fast, offline, deterministic call on a string constant — no network, no filesystem, no timing or platform dependence. The
\donttest{}looks like scaffold boilerplate; no reason for it is recorded anywhere in the repo.Fixed in the roxygen blocks (
R/punycoder.R,R/validators.R) and regeneratedman/with roxygen2; both committed together. The.Rddiff is exactly the two wrapper lines per page.Verification
R CMD check --as-cranwithout--run-donttest, after a cleanrm -f src/*.o; R CMD INSTALL .:* checking examples ... OKVersion contains large components (1.2.1.9000)dev-version note, unrelated to this change.punycoder-Ex.R.Not a release blocker and independent of the 1.3.0 tag gate (PUNY-tjusxhgn); the version string / NEWS / cran-comments work stays deferred to that window.
🤖 Generated with Claude Code