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

Fix #61 #62

Merged
merged 1 commit into from
Jun 20, 2024
Merged

Fix #61 #62

merged 1 commit into from
Jun 20, 2024

Conversation

ramiromagno
Copy link
Collaborator

Issue was the unquoted use of %.>% in pkgdown's reference list. We should either quote it or, in this case, remove it as it does not make sense in the Package global state section.

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 oak 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 devel branch until you have checked off each task.

  • Place Closes #<insert_issue_number> into the beginning of your Pull z
    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 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 oak 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!

Issue was the unquoted use of %.>% in pkgdown's reference list. We should either quote it or, in this case, remove it as it does not make sense in the _Package global state_ section.
Copy link

Code Coverage

Package Line Rate Health
sdtm.oak 88%
Summary 88% (786 / 894)

@edgar-manukyan edgar-manukyan self-requested a review June 20, 2024 18:33
@rammprasad
Copy link
Collaborator

@ramiromagno pkgdown::build_site() is giving an error. We may have to remove the %.>% from L59 in the yml file.

@ramiromagno
Copy link
Collaborator Author

ramiromagno commented Jun 20, 2024 via email

Copy link
Collaborator

@edgar-manukyan edgar-manukyan left a comment

Choose a reason for hiding this comment

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

Thanks team, approving so that you merge whenever the lovely pkgdown site renders 🤗

Copy link
Collaborator

@rammprasad rammprasad left a comment

Choose a reason for hiding this comment

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

Perfect, TY.

@rammprasad rammprasad merged commit 9765aff into main Jun 20, 2024
13 checks passed
@rammprasad rammprasad deleted the 0061-pkgdown-deployment-failure branch June 20, 2024 19:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

Successfully merging this pull request may close these issues.

General Issue: Documentation failed in main branch
3 participants