Skip to content
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.

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

Suggestion: allow files to be skipped #1680

Open
dmurdoch opened this issue Nov 19, 2024 · 0 comments
Open

Suggestion: allow files to be skipped #1680

dmurdoch opened this issue Nov 19, 2024 · 0 comments

Comments

@dmurdoch
Copy link

The suggestion is to allow a meta option like skip = c("filename.R") which would make Roxygen completely ignore that source file. (It might make sense to use a regular expression, but this is likely a rare enough need that exact filename matches are probably good enough.)

The motivation for this was described here: https://stat.ethz.ch/pipermail/r-package-devel/2024q4/011250.html . In summary, the issue is that .R files may contain code that should not be executed by Roxygen. When the load strategy is "source" or "pkgload", that code will be executed.

My current workaround is to use load strategy "installed", and it works, but it's less convenient than the others, because I may have to install, document, then install again after a change to the code in the package or I will see a stale help page.

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

No branches or pull requests

1 participant