Skip to content
New issue

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

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

Already on GitHub? # to your account

Address wrapper dontrun{} #374

Open
sarabodach opened this issue Jul 1, 2024 · 1 comment
Open

Address wrapper dontrun{} #374

sarabodach opened this issue Jul 1, 2024 · 1 comment
Assignees
Labels
dev Related to testing, versions, workflow, etc. documentation Improvements or additions to documentation

Comments

@sarabodach
Copy link
Collaborator

\dontrun{} should only be used if the example really cannot be executed (e.g. because of missing additional software, missing API keys, ...) by the user. That's why wrapping examples in \dontrun{} adds the comment ("# Not run:") as a warning for the user. Does not seem necessary. Please replace \dontrun with \donttest.
Please unwrap the examples if they are executable in < 5 sec, or replace dontrun{} with \donttest{}.
-> create_R_script.Rd; report_to_xlsx.Rd; xlsx2list.Rd
@sarabodach sarabodach mentioned this issue Jul 1, 2024
@sarabodach sarabodach self-assigned this Jul 1, 2024
@sarabodach sarabodach added documentation Improvements or additions to documentation dev Related to testing, versions, workflow, etc. labels Jul 1, 2024
@sarabodach
Copy link
Collaborator Author

Refer to issue of 2216 from https://github.com/r-lib/devtools/issues

image

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
dev Related to testing, versions, workflow, etc. documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant