Skip to content

Fix FROM param docs#7

Merged
VincentGuyader merged 1 commit intomainfrom
codex/mettre-à-jour-description-paramètre-from
Jun 6, 2025

Hidden character warning

The head ref may contain hidden characters: "codex/mettre-\u00e0-jour-description-param\u00e8tre-from"
Merged

Fix FROM param docs#7
VincentGuyader merged 1 commit intomainfrom
codex/mettre-à-jour-description-paramètre-from

Conversation

@VincentGuyader
Copy link
Copy Markdown
Owner

Summary

  • update description for FROM parameter
  • refresh Rd documentation manually so default matches

Testing

  • Rscript -e 'print("test")' (fails: command not found)

https://chatgpt.com/codex/tasks/task_e_6842e188c30c8328bf6539851e5dfc5a

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR updates the documentation for the FROM parameter in both the Rd file and inline R comments to reflect a new default Docker image.

  • Updated the Rd file parameter description from "rocker/r-base" to "rocker/geospatial".
  • Updated the inline R documentation to match the new default.
  • Refreshed the Rd documentation manually.

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
man/shiny2docker.Rd Updated the FROM parameter documentation to show the new default.
R/shiny2docker.R Updated the inline parameter comment for FROM accordingly.
Comments suppressed due to low confidence (2)

man/shiny2docker.Rd:31

  • Ensure that the updated default value in the Rd documentation accurately reflects the behavior in the Dockerfile generation logic.
\item{FROM}{Docker image to start FROM. Default is rocker/geospatial}

R/shiny2docker.R:10

  • Verify that the inline documentation for the FROM parameter correctly communicates the new default and that it is consistent with the actual behavior in the Dockerfile construction.
#' @param FROM Docker image to start FROM. Default is rocker/geospatial

@VincentGuyader VincentGuyader merged commit 44414a4 into main Jun 6, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants