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

Closes # 459 keeping the documentation of the deprecated functions/arguments up to date #464

Merged
merged 2 commits into from
Aug 30, 2024

Conversation

sadchla-codes
Copy link
Collaborator

@sadchla-codes sadchla-codes commented Aug 30, 2024

Thank you for your Pull Request! We have developed this task checklist from the Development Process Guide to help with the final steps of the process. Completing the below tasks helps to ensure our reviewers can maximize their time on your code as well as making sure the admiral codebase remains robust and consistent.

Please check off each taskbox as an acknowledgment that you completed the task or check off that it is not relevant to your Pull Request. This checklist is part of the Github Action workflows and the Pull Request will not be merged into the main branch until you have checked off each task.

  • Place Closes #<insert_issue_number> into the beginning of your Pull Request Title (Use Edit button in top-right if you need to update)
  • Code is formatted according to the tidyverse style guide. Run styler::style_file() to style R and Rmd files
  • Updated relevant unit tests or have written new unit tests, which should consider realistic data scenarios and edge cases, e.g. empty datasets, errors, boundary cases etc. - See Unit Test Guide
  • If you removed/replaced any function and/or function parameters, did you fully follow the deprecation guidance?
  • Update to all relevant roxygen headers and examples, including keywords and families. Refer to the categorization of functions to tag appropriate keyword/family.
  • Run devtools::document() so all .Rd files in the man folder and the NAMESPACE file in the project root are updated appropriately
  • Address any updates needed for vignettes and/or templates
  • Update NEWS.md under the header # admiral (development version) if the changes pertain to a user-facing function (i.e. it has an @export tag) or documentation aimed at users (rather than developers)
  • Build admiral site pkgdown::build_site() and check that all affected examples are displayed correctly and that all new functions occur on the "Reference" page.
  • Address or fix all lintr warnings and errors - lintr::lint_package()
  • Run R CMD check locally and address all errors and warnings - devtools::check()
  • Link the issue in the Development Section on the right hand side.
  • Address all merge conflicts and resolve appropriately
  • Pat yourself on the back for a job well done! Much love to your accomplishment!

@sadchla-codes sadchla-codes changed the title Closes # 459 keeping the documentation of the deprecated functions/ar… Closes # 459 keeping the documentation of the deprecated functions/arguments up to date Aug 30, 2024
Copy link

github-actions bot commented Aug 30, 2024

Code Coverage

Package Line Rate Health
admiraldev 97%
Summary 97% (1044 / 1078)

Copy link
Collaborator

@StefanThoma StefanThoma left a comment

Choose a reason for hiding this comment

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

LGTM!

@bms63
Copy link
Collaborator

bms63 commented Aug 30, 2024

Many thanks @sadchla-codes. I think the PR you were working on @ProfessorP-beep might not be needed anymore. https://github.com/pharmaverse/admiraldev/pulls

@bms63 bms63 merged commit 8d56877 into main Aug 30, 2024
16 checks passed
@bms63 bms63 deleted the Closes_459_deprecation_cleanup_documentation branch August 30, 2024 14:31
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.

General Issue: Move deprecated arguments and functions to next phase or remove
3 participants