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

Interface harmonisation step 1, renaming most outpack functions #46

Merged
merged 7 commits into from
Jul 26, 2023

Conversation

richfitz
Copy link
Member

Based on #45, diff will clear up after merge

This PR:

  • removes outpack functions that are no longer called by users (outpack_packet_*, outpack_checksum, outpack_id, outpack_root_open); these were to support orderly2 when it was a consumer of outpack
  • renames most other functions from outpack_ to orderly_ with no change in functionality, even where I wanted to
  • reorganises the docs where there were dangling links (and only there)

Each commit passes R CMD check so can be easily checked on its own, though they need to be applied in this order to avoid some conflicts.

The next ones in this series will

  • rename the location ones (easiest if we can Add support for pushing into outpack_server #42) merged first but I can rebase that if needed
  • rename the configuration ones (but probably need to think more careful about config at the same time)
  • rename outpack_init (but there's a ticket about init to do at the same time or nearby - this collides with an orderly function)

Then there's some harmonisation of argument names to do

@codecov
Copy link

codecov bot commented Jul 26, 2023

Codecov Report

Patch coverage: 100.00% and no project coverage change.

Comparison is base (97b4554) 100.00% compared to head (b29c738) 100.00%.

❗ Current head b29c738 differs from pull request most recent head 9c52775. Consider uploading reports for the commit 9c52775 to get more accurate results

Additional details and impacted files
@@            Coverage Diff            @@
##              main       #46   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           35        35           
  Lines         2781      2781           
=========================================
  Hits          2781      2781           
Files Changed Coverage Δ
R/interactive.R 100.00% <ø> (ø)
R/outpack_checksum.R 100.00% <ø> (ø)
R/outpack_helpers.R 100.00% <ø> (ø)
R/outpack_location.R 100.00% <ø> (ø)
R/outpack_logging.R 100.00% <ø> (ø)
R/outpack_metadata.R 100.00% <ø> (ø)
R/outpack_misc.R 100.00% <ø> (ø)
R/outpack_root.R 100.00% <ø> (ø)
R/query_deparse.R 100.00% <ø> (ø)
R/run.R 100.00% <ø> (ø)
... and 5 more

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

@r-ash r-ash self-requested a review July 26, 2023 13:33
Copy link
Contributor

@r-ash r-ash left a comment

Choose a reason for hiding this comment

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

We chatted through this, changes look good!

@r-ash r-ash merged commit ccee629 into main Jul 26, 2023
7 checks passed
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.

2 participants