Skip to content

Commit b800805

Browse files
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.
1 parent 54b7c7b commit b800805

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

R/utils.R

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ cat_info <- function(...) {
3939
#' default) and an `ENV GITHUB_PAT=${GITHUB_PAT}` propagation so any
4040
#' subsequent RUN inherits the value. For `"none"` and `"secret"`, no
4141
#' top-level directive is emitted (in `"secret"` mode the secret is
42-
#' mounted RUN-by-RUN by [.github_pat_run_prefix()]).
42+
#' mounted RUN-by-RUN by `.github_pat_run_prefix()`).
4343
#' Side-effects only: modifies `dock` in place.
4444
#' @noRd
4545
.github_pat_setup <- function(dock, mode) {
@@ -54,7 +54,7 @@ cat_info <- function(...) {
5454
#'
5555
#' Returns a string to prepend to a RUN command body. Empty string for
5656
#' modes `"none"` and `"build_arg"` (the latter relies on the ENV set
57-
#' by [.github_pat_setup()]); a `--mount=type=secret,...` fragment plus
57+
#' by `.github_pat_setup()`); a `--mount=type=secret,...` fragment plus
5858
#' a shell `GITHUB_PAT=$(cat ...)` prefix for mode `"secret"`.
5959
#'
6060
#' The file-read pattern (`cat /run/secrets/github_pat`) is preferred

0 commit comments

Comments
 (0)