Skip to content

Prune stale Rd when last topic removed; refresh stale README#28

Merged
TroyHernandez merged 2 commits into
mainfrom
fix-prune-empty-and-readme
Jun 24, 2026
Merged

Prune stale Rd when last topic removed; refresh stale README#28
TroyHernandez merged 2 commits into
mainfrom
fix-prune-empty-and-readme

Conversation

@TroyHernandez

Copy link
Copy Markdown
Contributor

Two findings from a review (codex) on the 0.4.0 candidate:

  • High: document() returned early on the no-blocks path before pruning, so deleting the final documented topic left its man/*.Rd behind. Now it prunes on that path too — when nothing is generated, every tinyrox-owned Rd is stale. Added a test_prune.R case (remove the only roxygen → its Rd is pruned).
  • Docs: the README still referenced the removed check_description_cran()/fix_description_cran() and the DESCRIPTION-quoting checks, and wrongly said unknown tags "fail fast". Updated to the code/example checks only, and corrected to warn-and-skip.

(A third finding — check_cran()'s result no longer carries $description — is a NEWS note, handled in the 0.4.0 release entry.)

212/0 tests; --as-cran clean. Folds into the 0.4.0 release.

document() returned early on the no-blocks path before pruning, so deleting the final documented topic left its Rd behind (codex review). Prune on that path too (every tinyrox-owned Rd is stale when nothing is generated). Also drop the README's references to the removed check_description_cran()/fix_description_cran() and correct the unknown-tag behaviour (warn-and-skip, not fail-fast).
@TroyHernandez TroyHernandez merged commit 539403f into main Jun 24, 2026
2 checks passed
@TroyHernandez TroyHernandez deleted the fix-prune-empty-and-readme branch June 24, 2026 14:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant