Skip to content

docs: fold in Copilot's #115 review nits + restore lost VignetteIndexEntry#116

Merged
VincentGuyader merged 1 commit into
masterfrom
docs/copilot-doc-nits
May 12, 2026
Merged

docs: fold in Copilot's #115 review nits + restore lost VignetteIndexEntry#116
VincentGuyader merged 1 commit into
masterfrom
docs/copilot-doc-nits

Conversation

@VincentGuyader
Copy link
Copy Markdown
Member

Summary

Follow-up to #115. Two things:

  1. Restore the %\VignetteIndexEntry{Getting started with dockerfiler} fix that was lost: Pre-CRAN polish for 0.3.0 (+ keep Colin as maintainer) #115 was merged from 437c48a, before the 2dcdc73 force-push that aligned the vignette's \VignetteIndexEntry{} to its YAML title:. Without it, rmarkdown emits a title-mismatch warning when rendering the vignette.

  2. Fold in Copilot's three inline comments on Pre-CRAN polish for 0.3.0 (+ keep Colin as maintainer) #115:

    • vignettes/dockerfiler.Rmd: heading "Create a Dockerfile from an renv.lock" → "... from a renv.lock".
    • R/rthis.R @examples, vignettes/dockerfiler.Rmd "Basic workflow" chunk, and README.Rmd: the illustrative install.packages(..., repos = "http://cran.irsn.fr/") now uses CRAN's canonical HTTPS mirror https://cloud.r-project.org instead of a plaintext-HTTP regional mirror.

man/r.Rd regenerated; README.md re-knit. No code-logic change.

Verification

  • devtools::test() on test-r.R: 0 failures.
  • Vignette renders clean (no title-mismatch warning).
  • No cran.irsn.fr left anywhere; no en/em-dashes in source.
  • (copilot-feedback triaged the 3 comments as partially-valid — the http→https framing as "insecure" is overstated since R CMD check --as-cran doesn't check URLs inside \examples{}, but it's a real hygiene improvement; factorized into pr-reviewer.md check Install quarto-cli system dependency when needed #42.)

Test plan

  • CI green.
  • Copilot review (should be clean — these address its prior comments).

…Entry

#115 was merged from commit 437c48a, before the 2dcdc73 force-push that
fixed the vignette index entry, so that fix was lost; this restores it.
Plus the three Copilot inline comments on #115:

- `vignettes/dockerfiler.Rmd`: section heading "Create a Dockerfile
  from an renv.lock" -> "... from a renv.lock" (article).
- `R/rthis.R` `@examples`, `vignettes/dockerfiler.Rmd` "Basic
  workflow" chunk, `README.Rmd`: the illustrative
  `install.packages(..., repos = "http://cran.irsn.fr/")` now uses
  the canonical HTTPS CRAN mirror `https://cloud.r-project.org`
  instead of a plaintext-HTTP regional mirror.
- restored `%\VignetteIndexEntry{Getting started with dockerfiler}`
  so it matches the vignette's YAML `title:` (silences the
  rmarkdown title-mismatch warning).

regenerated `man/r.Rd`; re-knit `README.md`. No code-logic change.
`devtools::test()` on the touched test file: 0 failures. Vignette
renders clean. No en/em-dashes in source.
@VincentGuyader
Copy link
Copy Markdown
Member Author

/copilot review

@VincentGuyader VincentGuyader merged commit fab02f2 into master May 12, 2026
6 checks passed
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.

1 participant