Fix stale flag.names_list roxygen title and remove dead code - #43
Open
vertesy wants to merge 1 commit into
Open
Conversation
- flag.names_list()'s @title incorrectly said "flag.names_list.all.new" (leftover from an incomplete rename); this corrupted the generated man/flag.names_list.Rd, whose \title was wrong and whose \details leaked raw roxygen source text from an older, superseded block. Fixed the source and regenerated the Rd via roxygen2. - Fixed a broken doc cross-reference in idate.Rd: the literal "[2]" in its @PARAM text was being parsed as a markdown link by roxygen, producing a dangling \link{2}; wrapped it in a code span instead. - Removed dead code: a stale "obsolete roxygen removed" comment, a commented-out superseded alternate implementation of flag.names_list(), and a fully commented-out stopif() implementation at the end of the file that is entirely superseded by the active stopif() defined earlier. - Removed repository cruft: an empty duplicate Development/CITATION.cff, a non-functional macOS Finder alias file, and a stale 937-line pre-refactor backup of the R source (Development/Development.bac). Development/ is .Rbuildignore'd, so none of this affects the build. No behavior change; no version bump.
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.
Summary
Documentation and dead-code cleanup only — no behavior change, no version bump.
flag.names_list()'s@titleincorrectly saidflag.names_list.all.new(leftover from an incomplete rename). This had corrupted the generatedman/flag.names_list.Rd: its\titlewas wrong, and its\detailssection leaked raw roxygen source text from an older, superseded block (verified via a scripted name/title/leaked-marker scan across all 84.Rdfiles in the repo — this is the only one affected). Fixed the source and regenerated the.Rdvia roxygen2.idate.Rd: the literal[2]in its@paramtext was being parsed as a markdown link by roxygen (sinceRoxygen: list(markdown = TRUE)), producing a dangling\link{2}. Wrapped it in a code span instead.flag.names_list(), and a fully commented-outstopif()implementation at the end of the file that's entirely superseded by the activestopif()defined earlier.Development/CITATION.cff, a non-functional macOS Finder alias file, and a stale 937-line pre-refactor backup of the R source (Development/Development.bac).Development/is.Rbuildignore'd, so none of this touches the build.Validation
R CMD check and the existing
testthatsuite (7/7 passing) were run on this branch (R toolchain installed for this work). Remaining R CMD check findings on this branch are pre-existing and out of scope here (fixed in sibling PRs in this batch): theparFlags()example error,parsepvalue()'s undocumentedprefix, and the%!in%Rd-name warning plus a sandbox locale warning (both environment-inherent).Generated by Claude Code