docs: polish bundle for 0.3.0 (renv_version doc, distro removal, vignette cleanup, typos)#104
Merged
VincentGuyader merged 5 commits intomasterfrom May 6, 2026
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR bundles a set of documentation-focused cleanups ahead of the 0.3.0 release, clarifying dock_from_renv() semantics, removing deprecated distro usage from examples, deleting an unused placeholder vignette, and polishing minor wording/typos (plus one small internal code cleanup in get_sysreqs()).
Changes:
- Clarify the three-mode behavior of
dock_from_renv(renv_version = ...)(missing vsNULLvs explicit version) in roxygen docs and the generated Rd. - Remove deprecated
distro = ...from examples and delete the unuseddockerfile-from-renv-lockvignette stub. - Fix small typos / wording in README + vignettes + comments; simplify
get_sysreqs()by removing a dead statement.
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| vignettes/dockerfiler.Rmd | Fixes a vignette section header typo (“workflow”). |
| vignettes/dockerfile-from-renv-lock.Rmd | Removes an unused placeholder vignette file. |
| README.Rmd | Fixes “workflow” typo, corrects install.packages() arg name (repos), and removes deprecated distro from the renv example. |
| README.md | Re-knit output reflecting the README.Rmd doc/example updates. |
| R/parse-dockerfile.R | Corrects spelling in a comment (“compatibility”). |
| R/get_sysreqs.R | Removes a dead unlist(...) call and tidies spacing in pak::pkg_sysreqs() invocation. |
| R/dock_from_renv.R | Documents the renv_version missing-vs-NULL distinction and removes deprecated distro from roxygen examples. |
| R/compact_sysreqs.R | Translates an inline comment to English. |
| man/dock_from_renv.Rd | Regenerated Rd reflecting the updated renv_version docs and example cleanup. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
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.
Summary
Bundles four documentation improvements surfaced by the pre-CRAN
audit. None changes runtime behaviour.
1.
dock_from_renv()@param renv_versionclarification (doc-only)The argument has three distinct semantic modes that the original
doc described as "optional with a default", which a reader can
mistake for a 2-state argument. Explicitly document the three
modes:
fall back to latest if not pinned.
NULL(explicit): force latest, even when the lockfile pins."1.0.0"): use that exact version.The missing-vs-NULL distinction is load-bearing in the function
body (a TDD POC trying to add a
= NULLdefault broke 3 existingtests; reverted in favor of doc-only).
2. Drop deprecated
distro = ...from doc examplesdistrohas been deprecated since 0.2.3 and emits awarning()on use. Three doc locations still showed it; removed:
R/dock_from_renv.R@examples\dontrun{}block.README.Rmdrenv example.vignettes/dockerfile-from-renv-lock.Rmd(deleted altogether,see create a dock$COMMENT() to add a comment in the Dockerfile #3).
3. Delete the empty placeholder vignette
vignettes/dockerfile-from-renv-lock.Rmdwas a fusen templatethat never got expanded into real content (50 lines, ~10 of which
are content, and that content was roxygen-syntax inside R-syntax
inside an Rmd chunk). A real "renv lockfile to Dockerfile"
vignette is worth writing post-CRAN; for now, deletion is the
honest move.
4. Cosmetic sweep
vignettes/dockerfiler.Rmd: "Basic worflow" -> "Basic workflow".README.Rmd: same typo, plusrepo =->repos =in theinstall.packages()example wrapped byr().R/parse-dockerfile.R: "compatability" -> "compatibility".R/compact_sysreqs.R: French inline comment translated.R/get_sysreqs.R: drop a deadunlist(...)whose output wasoverwritten on the next line.
README.md is re-knit at the end of the bundle.
Test plan
branch and verified
R CMD check --as-cran0/0/0 (5 / 5individually).
R CMD check --as-cran0/0/0 twice: once pre-rebase, once post-rebase on master
after docs(vignette): point install_github at ThinkR-open instead of colinfay #103 landed.
changes regenerate
man/dock_from_renv.Rdaccordingly.Context
Étape 2 / 8 of the 0.3.0 CRAN-prep plan. Étape 1 was #103
(vignette fork rename, merged at
a7215ec).Refs the local prep report at
/home/ubuntu/thinkr-work/dockerfiler-cran-0.3.0-prep.mdforthe full audit and rationale.