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

Cran edits #117

Merged
merged 3 commits into from
Apr 15, 2024
Merged

Cran edits #117

merged 3 commits into from
Apr 15, 2024

Conversation

slager
Copy link
Contributor

@slager slager commented Apr 15, 2024

First batch of edits addresses the following issues identified during manual CRAN submission review:

  • Please add \value to .Rd files regarding exported methods and explain the functions results in the documentation. Please write about the structure of the output (class) and also what the output means. (If a function does not return a value, please document that too, e.g.
\value{No return value, called for side effects} or similar) Missing Rd-tags:
      data_version.Rd: \value
      datapackage_skeleton.Rd: \value
      document.Rd: \value
      keepDataObjects-defunct.Rd: \value
      package_build.Rd: \value
  • \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{}.
    -> datapackager_object_read.R; document.Rd

  • You are setting options(warn=-1) in your function. This is not allowed. Please rather use suppressWarnings() if really needed.
    -> R/digests.R

@slager slager merged commit 4f79b00 into develop Apr 15, 2024
7 checks passed
@slager slager deleted the cran_edits branch April 15, 2024 20:35
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

Successfully merging this pull request may close these issues.

None yet

1 participant