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

Make rt=NULL settings explicit #779

Merged
merged 4 commits into from
Sep 24, 2024
Merged

Make rt=NULL settings explicit #779

merged 4 commits into from
Sep 24, 2024

Conversation

jamesmbaazam
Copy link
Contributor

Description

This PR closes #761.

This PR makes explicit the settings that are applied when rt=NULL in functions that use that argument.

Initial submission checklist

  • My PR is based on a package issue and I have explicitly linked it.
  • I have tested my changes locally (using devtools::test() and devtools::check()).
  • I have added or updated unit tests where necessary.
  • I have updated the documentation if required and rebuilt docs if yes (using devtools::document()).
  • I have followed the established coding standards (and checked using lintr::lint_package()).
  • I have added a news item linked to this PR.

After the initial Pull Request

  • I have reviewed Checks for this PR and addressed any issues as far as I am able.

@jamesmbaazam jamesmbaazam added the documentation Improvements or additions to documentation label Sep 19, 2024
@jamesmbaazam
Copy link
Contributor Author

This was what I had in mind when I raised this issue. Happy to rephrase based on reviews but I keep going back into the code to remind myself of the applied settings, so I thought would be useful to expose it.

Copy link
Contributor

@sbfnk sbfnk left a comment

Choose a reason for hiding this comment

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

Good idea

NEWS.md Outdated Show resolved Hide resolved
R/create.R Outdated Show resolved Hide resolved
@sbfnk sbfnk added this pull request to the merge queue Sep 24, 2024
Merged via the queue into main with commit b806ef1 Sep 24, 2024
9 checks passed
@sbfnk sbfnk deleted the doc-rt-null branch September 24, 2024 09:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document/surface what settings are applied when rt = NULL.
2 participants