New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Consider `@examplesIf` in documentation #564

Open

wibeasley opened this issue Jan 11, 2025 · 0 comments

Assignees

Labels

Member

wibeasley commented Jan 11, 2025

https://r-pkgs.org/man.html#sec-man-examples-dependencies-conditional-execution

Advantages are

Users won’t actually see the if() { … } machinery when they are reading your documentation from within R or on a pkgdown website. Users only see realistic code.

The example code renders fully in pkgdown.

The example code runs when it should and does not run when it should not.

This doesn’t run afoul of CRAN’s prohibition of putting all your example code inside \dontrun{}.

wibeasley added the enhancement label

wibeasley self-assigned this

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment