checkhelper
checkhelper copied to clipboard
As a dev, \dontrun{} should only be used if the example really cannot be executed
Validation criteria
- [ ] I would like
{checkhelper}to remind me of the different calls to\dontrun{}in my package. - [ ] I would like
{checkhelper}to warn me if\dontrun{}could be replace with\donttest{}:- [ ] Remind me the difference between both
- [ ] Warn me where i could change
- [ ] A template message to explain why i want to keep
\dontrun{}
Technical
In .Rd change all \dontrun{} into \donttest{} and then devtools::run_examples()
Run one by one and detect which one failed or not. If failed -> \dontrun{} if not maybe change for \donttest{}
- [ ] If you keep the
\dontrun{}for some (good) reasons, add a message to explain why you decided to keep it.