Fix FROM param docs#7
Merged
VincentGuyader merged 1 commit intomainfrom Jun 6, 2025
Hidden character warning
The head ref may contain hidden characters: "codex/mettre-\u00e0-jour-description-param\u00e8tre-from"
Merged
Conversation
Contributor
There was a problem hiding this comment.
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
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
FROMparameterTesting
Rscript -e 'print("test")'(fails: command not found)https://chatgpt.com/codex/tasks/task_e_6842e188c30c8328bf6539851e5dfc5a