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

Issue #535: Create pkgdown docs for stable and dev versions #550

Merged
merged 5 commits into from
Jan 5, 2024

Conversation

sbfnk
Copy link
Contributor

@sbfnk sbfnk commented Jan 5, 2024

Description

This PR closes #535.

It does so by setting the development version (four components) as done in the usethis package.

It also adds a note for the user to clarify which version of the documentation they're looking at. This is mostly to help people arriving from a search engine.

Checklist

  • My PR is based on a package issue and I have explicitly linked it.
  • I have included the target issue or issues in the PR title as follows: issue-number: PR title
  • I have tested my changes locally.
  • I have added or updated unit tests where necessary.
  • I have updated the documentation if required.
  • I have built the package locally and run rebuilt docs using roxygen2.
  • My code follows the established coding standards and I have run lintr::lint_package() to check for style issues introduced by my changes.
  • I have added a news item linked to this PR.
  • I have reviewed CI checks for this PR and addressed them as far as I am able.

README.Rmd Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@sbfnk sbfnk changed the base branch from main to develop January 5, 2024 11:46
@sbfnk sbfnk changed the base branch from develop to main January 5, 2024 12:29
@sbfnk sbfnk changed the title 535: Create pkgdown docs for stable and dev versions Issue #535: Create pkgdown docs for stable and dev versions Jan 5, 2024
@sbfnk sbfnk changed the base branch from main to develop January 5, 2024 13:58
Copy link

codecov bot commented Jan 5, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (52e2cb8) 84.55% compared to head (55e178b) 84.55%.

❗ Current head 55e178b differs from pull request most recent head 0214000. Consider uploading reports for the commit 0214000 to get more accurate results

Additional details and impacted files
@@           Coverage Diff            @@
##           develop     #550   +/-   ##
========================================
  Coverage    84.55%   84.55%           
========================================
  Files           21       21           
  Lines         1722     1722           
========================================
  Hits          1456     1456           
  Misses         266      266           

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

@sbfnk sbfnk force-pushed the pkgdown-update branch 2 times, most recently from 1332194 to b0b2a53 Compare January 5, 2024 13:59
@sbfnk sbfnk requested a review from seabbs January 5, 2024 14:05
Copy link
Contributor

@seabbs seabbs left a comment

Choose a reason for hiding this comment

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

LGTM. Actions user your alive!

@seabbs seabbs merged commit 8796b9f into develop Jan 5, 2024
10 checks passed
@seabbs seabbs deleted the pkgdown-update branch January 5, 2024 14:25
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.

Decide on package development workflow and release policies
3 participants