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 #81 Review the deepdive vignette #191

Merged
merged 4 commits into from
Dec 7, 2023
Merged

Closes #81 Review the deepdive vignette #191

merged 4 commits into from
Dec 7, 2023

Conversation

vedhav
Copy link
Collaborator

@vedhav vedhav commented Nov 27, 2023

Changes Description

Make some minor corrections to the deep-dive vignette and close #81

Task List

  • The spirit of xportr is met in your Pull Request
  • Place Closes #<insert_issue_number> into the beginning of your Pull Request Title (Use Edit button in top-right if you need to update)
  • Summary of changes filled out in the above Changes Description. Can be removed or left blank if changes are minor/self-explanatory.
  • Check that your Pull Request is targeting the devel branch, Pull Requests to main should use the Release Pull Request Template
  • Code is formatted according to the tidyverse style guide. Use styler package and functions to style files accordingly.
  • Updated relevant unit tests or have written new unit tests. See our Wiki for conventions used in this package.
  • Creation/updated relevant roxygen headers and examples. See our Wiki for conventions used in this package.
  • Run devtools::document() so all .Rd files in the man folder and the NAMESPACE file in the project root are updated appropriately
  • Run pkgdown::build_site() and check that all affected examples are displayed correctly and that all new/updated functions occur on the "Reference" page.
  • 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)
  • Address any updates needed for vignettes and/or templates
  • Link the issue Development Panel so that it closes after successful merging.
  • Fix merge conflicts
  • Pat yourself on the back for a job well done! Much love to your accomplishment!

Copy link

codecov bot commented Nov 27, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (ef3170b) 100.00% compared to head (b09805e) 100.00%.
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main      #191   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           12        12           
  Lines          588       588           
=========================================
  Hits           588       588           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@bms63 bms63 self-requested a review November 30, 2023 16:36
@bms63 bms63 changed the title Review the deepdive vignette Closes #81 Review the deepdive vignette Dec 7, 2023
@bms63
Copy link
Collaborator

bms63 commented Dec 7, 2023

I added in a short blurb to the news and added issue numbers into all the entries.

I think it is okay to over-document changes in the news.

@bms63 bms63 merged commit 77322bb into main Dec 7, 2023
13 checks passed
@bms63 bms63 deleted the 81_vignette_review branch December 7, 2023 19:46
@vedhav
Copy link
Collaborator Author

vedhav commented Dec 8, 2023

Thanks Ben! Also, love the addition of PR# in the news making it easy to dive deeper.

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.

More Documentation to explain how xportr functions work
2 participants