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

Move Data Package compatibility to vignettes #246

Merged
merged 41 commits into from
Aug 27, 2024
Merged

Move Data Package compatibility to vignettes #246

merged 41 commits into from
Aug 27, 2024

Conversation

peterdesmet
Copy link
Member

@peterdesmet peterdesmet commented Jul 10, 2024

Fix #208

  • Write Data Package vignette
  • Write Data Resource vignette
  • Write Table Dialect vignette
  • Write Table Schema vignette
  • Link to vignettes from README
  • Link to vignettes from introduction: not needed
  • Update all function documentation to link to vignettes
  • Make sure vignettes can run locally (see Do not require internet connection for example_package #114)
  • Remove TODOs
  • Resolve conflicts

@peterdesmet
Copy link
Member Author

peterdesmet commented Jul 10, 2024

@sannegovaert could you already review the Data Resource and Table Dialect vignettes? You can see them locally by running pkgdown::build_articles().

Copy link

codecov bot commented Jul 10, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (f9185cb) to head (5e46bed).
Report is 42 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main      #246   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           22        22           
  Lines          626       626           
=========================================
  Hits           626       626           

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

@peterdesmet peterdesmet added the documentation Improvements or additions to documentation label Jul 12, 2024
@peterdesmet peterdesmet marked this pull request as ready for review August 23, 2024 13:54
@peterdesmet
Copy link
Member Author

@sannegovaert this PR is now ready for review:

  • The vignettes have been updated (including the two you reviewed already)
  • Functions reference the vignettes (and remove content that is now described in the vignette)
  • The README mentions that v1 is supported
  • Other minor updates

As before, you can build the site locally with pkgdown::build_site().

@peterdesmet peterdesmet mentioned this pull request Aug 26, 2024
22 tasks
@peterdesmet peterdesmet added this to the 1.2.0 milestone Aug 26, 2024
Copy link
Contributor

@sannegovaert sannegovaert left a comment

Choose a reason for hiding this comment

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

Looks good! I only have some small suggestions.

R/add_resource.R Show resolved Hide resolved
R/add_resource.R Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
vignettes/data-resource.Rmd Show resolved Hide resolved
vignettes/data-resource.Rmd Show resolved Hide resolved
vignettes/data-resource.Rmd Outdated Show resolved Hide resolved
vignettes/data-resource.Rmd Outdated Show resolved Hide resolved
vignettes/data-resource.Rmd Outdated Show resolved Hide resolved
@peterdesmet
Copy link
Member Author

@sannegovaert changes made, please see the 3 open conversations if you agree.

@sannegovaert
Copy link
Contributor

@sannegovaert changes made, please see the 3 open conversations if you agree.

All good!

@peterdesmet peterdesmet merged commit 0520f14 into main Aug 27, 2024
8 checks passed
@peterdesmet peterdesmet deleted the vignettes branch August 27, 2024 09:20
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.

Move read_resource documentation to article
2 participants