From b8008059d61b357c69f643b73bcff1a72172710d Mon Sep 17 00:00:00 2001 From: Vincent Guyader Date: Wed, 13 May 2026 11:15:24 +0200 Subject: [PATCH] docs: silence devtools::document() roxygen link warnings `R/utils.R` had two `@description` blocks for the internal `.github_pat_setup` / `.github_pat_run_prefix` helpers that cross-referenced each other via `[.github_pat_X()]` markdown links. Both helpers are `@noRd` so no `.Rd` is generated, and roxygen emitted "Could not resolve link to topic" warnings on every `devtools::document()` run. Switched the references to plain backticks (`.github_pat_X()`): the prose stays explanatory, no link is attempted, no warning. Pure docstring cleanup; no `.Rd`, no NAMESPACE, no behaviour change. --- R/utils.R | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/R/utils.R b/R/utils.R index 12cea07..6283bc5 100644 --- a/R/utils.R +++ b/R/utils.R @@ -39,7 +39,7 @@ cat_info <- function(...) { #' default) and an `ENV GITHUB_PAT=${GITHUB_PAT}` propagation so any #' subsequent RUN inherits the value. For `"none"` and `"secret"`, no #' top-level directive is emitted (in `"secret"` mode the secret is -#' mounted RUN-by-RUN by [.github_pat_run_prefix()]). +#' mounted RUN-by-RUN by `.github_pat_run_prefix()`). #' Side-effects only: modifies `dock` in place. #' @noRd .github_pat_setup <- function(dock, mode) { @@ -54,7 +54,7 @@ cat_info <- function(...) { #' #' Returns a string to prepend to a RUN command body. Empty string for #' modes `"none"` and `"build_arg"` (the latter relies on the ENV set -#' by [.github_pat_setup()]); a `--mount=type=secret,...` fragment plus +#' by `.github_pat_setup()`); a `--mount=type=secret,...` fragment plus #' a shell `GITHUB_PAT=$(cat ...)` prefix for mode `"secret"`. #' #' The file-read pattern (`cat /run/secrets/github_pat`) is preferred