Prune stale tinyrox-generated Rd files during document() (#22)#26
Merged
Conversation
After regenerating, document() removes man/*.Rd pages it no longer produces (renamed or deleted topics), but only files tinyrox owns: line 1 must be the marker, now factored into a shared RD_MARKER constant so the generator and the ownership check cannot drift. Hand-written Rd, and Rd from other tools, are never touched. New prune_rd argument (default TRUE) gates it; prune_rd = FALSE keeps the old behaviour. The returned list gains a pruned element.
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.
What
document()regenerates current Rd but never removed pages for topics that were renamed or deleted, leaving staleman/*.Rdthat can tripR CMD check(it bitllm.apiafter renaming a provider helper).document()now prunes stale Rd after regenerating — but conservatively:setdiff(existing, generated)) and tinyrox can prove it owns it: line 1 is exactly the tinyrox marker.prune_rdargument (defaultTRUE);prune_rd = FALSEkeeps the old keep-everything behaviour.prunedelement.The header marker is factored into a shared
RD_MARKERconstant used by both the generator and the new ownership check, so they can't drift.Tests
test_prune.Rcovers the spec: stale tinyrox Rd removed, current Rd kept, hand-written Rd (no marker) kept, renamed topic leaves no orphan, andprune_rd = FALSEpreserves the old behaviour.Version bumped to 0.3.3.7. Full tinytest suite passes (204).
Closes #22