docs: silence devtools::document() roxygen link warnings#118
Merged
Conversation
`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.
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
1 participant
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
Silences the two long-standing
devtools::document()warnings:Cause: the two internal helpers
.github_pat_setup()/.github_pat_run_prefix()are@noRd, so no.Rdis generated; their@descriptionblocks cross-reference each other via[.github_pat_X()]markdown links, which roxygen then can't resolve.Fix: switch the references from markdown links to plain backticks (
`.github_pat_X()`). Prose stays explanatory, no link is attempted, no warning.Diff
R/utils.R:42:[.github_pat_run_prefix()]→`.github_pat_run_prefix()`R/utils.R:57:[.github_pat_setup()]→`.github_pat_setup()`No
.Rdchange (the affected helpers are@noRd), no NAMESPACE change, no behaviour change.devtools::document()is now clean.Test plan
devtools::document(): no warnings.