Skip to content

Documentation: unwrap dontrun examples where not necessary #12

@martinctc

Description

@martinctc

Please unwrap the examples if they are executable in < 5 sec, or replace \dontrun{} with \donttest{}. This is more for CRAN compliance reasons.

\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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions