CSHS-CWRA / CSHShydRology

Main package
GNU Affero General Public License v3.0
35 stars 39 forks source link

CRAN issue #4 use of \dontrun instead of \donttest #72

Closed KevinShook closed 2 years ago

KevinShook commented 2 years ago

\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 in all cases.

Please unwrap the examples if they are executable in < 5 sec, or replace \dontrun{} with \donttest{}.

Please put functions which download data in \donttest{}.

Session Info ```r ```
KevinShook commented 2 years ago

Fixed