Skip to content

[r] Handling CRAN feedback for example snippets #5345

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

Merged
merged 2 commits into from
Feb 18, 2020

Conversation

saigiridhar21
Copy link
Contributor

CRAN committee recommended using dontrun instead of donttest. The reason is that the generated OpenAPI client library uses some sort of authentication and dontrun specifies that the example snippets can't be run without defining some additional configuration like API keys/username-password etc. whereas donttest specifies that examples can be run without any additional configurations manually.

PR checklist

  • Read the contribution guidelines.
  • If contributing template-only or documentation-only changes which will change sample output, build the project before.
  • Run the shell script(s) under ./bin/ (or Windows batch scripts under.\bin\windows) to update Petstore samples related to your fix. This is important, as CI jobs will verify all generator outputs of your HEAD commit, and these must match the expectations made by your contribution. You only need to run ./bin/{LANG}-petstore.sh, ./bin/openapi3/{LANG}-petstore.sh if updating the code or mustache templates for a language ({LANG}) (e.g. php, ruby, python, etc).
  • File the PR against the correct branch: master, 4.3.x, 5.0.x. Default: master.
  • Copy the technical committee to review the pull request if your PR is targeting a particular programming language.

@Ramanth

@auto-labeler
Copy link

auto-labeler bot commented Feb 17, 2020

👍 Thanks for opening this issue!
🏷 I have applied any labels matching special text in your issue.

The team will review the labels and make any necessary changes.

@saigiridhar21 saigiridhar21 changed the title [r] Fixing CRAN feedback [r] Handling CRAN feedback for example snippets Feb 17, 2020
Copy link
Contributor

@Ramanth Ramanth left a comment

Choose a reason for hiding this comment

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

LGTM

@wing328
Copy link
Member

wing328 commented Feb 17, 2020

CRAN committee recommended using dontrun instead of donttest

Do you have the URL to the recommendation for our reference?

@wing328 wing328 added this to the 4.3.0 milestone Feb 17, 2020
@saigiridhar21
Copy link
Contributor Author

CRAN committee recommended using dontrun instead of donttest

Do you have the URL to the recommendation for our reference?

CRAN shares feedback through email and so there is no recommendation link.

@wing328
Copy link
Member

wing328 commented Feb 18, 2020

@saigiridhar21 that's ok. I'm ok with this change.

@wing328 wing328 merged commit 4f7d45f into OpenAPITools:master Feb 18, 2020
@saigiridhar21 saigiridhar21 deleted the fix/r/cran-feedback branch February 18, 2020 13:47
MikailBag pushed a commit to MikailBag/openapi-generator that referenced this pull request Mar 23, 2020
* fix(r): Updating donttest to dontrun

* fix(r): Updating donttest to dontrun
@wing328
Copy link
Member

wing328 commented Mar 27, 2020

@saigiridhar21 thanks for the PR, which has been included in the 4.3.0 release: https://twitter.com/oas_generator/status/1243455743937789952

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants