Skip to content

Docs housekeeping - #40

Merged
jemus42 merged 7 commits into
masterfrom
examples
Jul 18, 2026
Merged

Docs housekeeping#40
jemus42 merged 7 commits into
masterfrom
examples

Conversation

@jemus42

@jemus42 jemus42 commented Jul 18, 2026

Copy link
Copy Markdown
Collaborator

Update roxygen2 usage a bit throughout, e.g.,

  • using @examplesIf tags instead of having if (requireNamespace(...)) blocks in examples
  • using markdown syntax throughout, much less verbose

as a side-effect, this also drops the rpf test exclusions whcih previously where extended to the examples on windows, so now we bump the rpf dependency and checks pass on windows again

jemus42 and others added 7 commits July 11, 2026 00:10
# Conflicts:
#	NEWS.md
#	R/glex.R
#	man/glex.Rd
#	tests/testthat/test-glex-xgboost.R
rpf 0.3.0 fixes the purify_3() out-of-bounds read that crashed R on
Windows (PlantedML/randomPlantedForest#61), so the skip_on_os() guards
and the OS condition in the rpf examples are no longer needed. Test
skips now pin the minimum version instead.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
roxygen2 8.0.0 conventions: Config/roxygen2/markdown field instead of
the Roxygen list, @returns instead of @return, and markdown bullets
instead of the last remaining \describe block. Fix a typo in the bike
data docs.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@jemus42
jemus42 merged commit 84fb1d5 into master Jul 18, 2026
6 checks passed
@jemus42
jemus42 deleted the examples branch July 18, 2026 01:11
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