Skip to content

[DOC] Fix the documentation to better match CRAN requirements #142

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.

Sign up for GitHub

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

Jump to bottom
Merged
tbouffard merged 3 commits into from
Nov 17, 2022
Merged

[DOC] Fix the documentation to better match CRAN requirements #142

tbouffard merged 3 commits into from
Nov 17, 2022

Conversation

@csouchet
Copy link
Contributor

@csouchet csouchet commented Nov 17, 2022 •
edited by tbouffard
Loading

The following updates are based on the last CRAN submission feedback:

  • DESCRIPTION: explain acronyms
  • bpmnVisualization-package.Rd
    • replace \dontrun with \donttest
    • update the example

covers #10

Last CRAN submission reject message

Please always explain all acronyms in the description text. -> 'BPMN'

\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. -> bpmnVisualization-package.Rd

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

Please fix and resubmit.

@csouchet csouchet added dependencies Pull requests that update a dependency (dev or runtime) documentation Improvements or additions to documentation and removed dependencies Pull requests that update a dependency (dev or runtime) labels Nov 17, 2022
@csouchet
Replace \dontrun with \donttest. -> bpmnVisualization-package.Rd
9a5732b 
\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.
@csouchet
Update the example in the bpmnVisualization-package.Rd file
038578d
@csouchet csouchet marked this pull request as ready for review November 17, 2022 10:30
@csouchet csouchet requested a review from tbouffard November 17, 2022 10:31
@tbouffard tbouffard changed the title [DOC] Fix the documentation with the returns of the last CRAN submission [DOC] Fix the documentation to better match CRAN requirements Nov 17, 2022
tbouffard
tbouffard approved these changes Nov 17, 2022
View reviewed changes
Copy link
Member

@tbouffard tbouffard left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@tbouffard tbouffard merged commit 074d2cb into main Nov 17, 2022
@tbouffard tbouffard deleted the update_doc branch November 17, 2022 10:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@tbouffard tbouffard tbouffard approved these changes

Assignees

No one assigned

Labels

documentation Improvements or additions to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@csouchet @tbouffard