Fix broken \link{} in movingAve2()/imovingSEM() @title tags - #71
Merged
Conversation
roxygen2's markdown mode (Roxygen: list(markdown = TRUE)) parses a bare `[Deprecated]` in an @title as a markdown reference-style link and silently converts it to \link{Deprecated} in the generated .Rd file - a broken link, since no help topic named "Deprecated" exists in this package. Confirmed by regenerating docs with roxygen2 and diffing against the checked-in .Rd files. Fix: use parentheses "(Deprecated)" instead of square brackets in both @title tags, which roxygen2's markdown parser leaves as plain text. Regenerated man/imovingSEM.Rd and man/movingAve2.Rd to confirm the fix (no \link{} in the output); NAMESPACE needed no change. Version bumped 2.8.15 -> 2.8.16 per repo convention for a real (if minor) doc-correctness fix. Note: R CMD check's dependency-availability step cannot complete in this sandbox because ReadWriter (a recently added hard Import) pulls in qs, which has a compile-time incompatibility with the stringfish version buildable here - a pre-existing environment limitation unrelated to this change. Verified instead via R CMD build (succeeds) plus direct roxygen2 regeneration/diffing as described above.
This was referenced Sep 1, 2026
Merged
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
2 participants
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.
What
The just-merged PR #65 added
@title ... [Deprecated]tomovingAve2()andimovingSEM(). WithRoxygen: list(markdown = TRUE)(this package's setting), roxygen2's markdown parser reads a bare[Deprecated]as a markdown reference-style link and silently converts it to\link{Deprecated}in the generated.Rdfile — a broken link, since no help topic named "Deprecated" exists anywhere in this package.Confirmed by regenerating docs with
roxygen2::roxygenise()from the current source and diffing against the checked-in.Rdfiles — before this fix, regeneration produces exactly this broken\link{Deprecated}in bothman/movingAve2.Rdandman/imovingSEM.Rd.Fix
Changed both
@titletags to use parentheses,(Deprecated), instead of square brackets. Regeneratedman/movingAve2.Rdandman/imovingSEM.Rdand confirmed the\link{}is gone and the rest of both files is unchanged;NAMESPACEneeded no change.Verification
R CMD build .succeeds.roxygen2::roxygenise()and diffed: only the intended[Deprecated]→(Deprecated)change in the two.Rdfiles, nothing else.R CMD check's dependency-availability step cannot complete in this sandbox:ReadWriter(a recently added hardImports) pulls inqs, which has a compile-time incompatibility with thestringfishversion buildable here. This is a pre-existing environment limitation, unrelated to this change (confirmed it also blocks a clean check on unmodifieddev). Relied on directR CMD build+ roxygen2 regeneration/diffing instead.2.8.15→2.8.16inDevelopment/config.R/DESCRIPTIONper repo convention.Small, mechanical, docs-only fix — no behavior change.
Generated by Claude Code