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

Remove old API (those prior to v0.5.0) #601

Merged
merged 8 commits into from
Mar 29, 2022

Conversation

leewujung
Copy link
Member

@leewujung leewujung commented Mar 28, 2022

This PR removes the old API Convert and Process prior to v0.5.0.

The changes include:

  • deletion of the subpackage process, convert/convert.py, convert/convert_combine.py
  • deletion of related test
  • revision of documentation

This addresses #506.

@leewujung leewujung added this to the 0.6.0 milestone Mar 28, 2022
@codecov-commenter
Copy link

codecov-commenter commented Mar 28, 2022

Codecov Report

Merging #601 (0a0f779) into dev (4239a88) will decrease coverage by 19.29%.
The diff coverage is n/a.

@@             Coverage Diff             @@
##              dev     #601       +/-   ##
===========================================
- Coverage   79.18%   59.88%   -19.30%     
===========================================
  Files          41       40        -1     
  Lines        3623     3600       -23     
===========================================
- Hits         2869     2156      -713     
- Misses        754     1444      +690     
Flag Coverage Δ
unittests 59.88% <ø> (-19.30%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
echopype/__init__.py 100.00% <ø> (ø)
echopype/convert/__init__.py 100.00% <ø> (ø)
echopype/convert/api.py 82.64% <ø> (-4.96%) ⬇️
echopype/echodata/echodata.py 85.08% <ø> (-5.94%) ⬇️
echopype/metrics/summary_statistics.py 0.00% <0.00%> (-96.43%) ⬇️
echopype/calibrate/ecs_parser.py 0.00% <0.00%> (-95.50%) ⬇️
echopype/utils/uwa.py 6.12% <0.00%> (-87.76%) ⬇️
echopype/calibrate/calibrate_ek.py 12.63% <0.00%> (-80.87%) ⬇️
echopype/utils/io.py 13.13% <0.00%> (-72.27%) ⬇️
echopype/preprocess/noise_est.py 22.85% <0.00%> (-71.43%) ⬇️
... and 10 more

📣 Codecov can now indicate which changes are the most critical in Pull Requests. Learn more

@leewujung leewujung requested review from emiliom and lsetiawan March 28, 2022 05:24
@leewujung leewujung marked this pull request as ready for review March 28, 2022 05:25
@leewujung leewujung changed the title Remove old API prior to v0.5.0 Remove old API (those prior to v0.5.0) Mar 28, 2022
Copy link
Member

@lsetiawan lsetiawan left a comment

Choose a reason for hiding this comment

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

LGTM! Feel free to either bring back the if section I mentioned above or leave your changes alone 😄

@leewujung
Copy link
Member Author

Thanks @lsetiawan ! I will leave that section in for future use. :)

@lsetiawan
Copy link
Member

lsetiawan commented Mar 28, 2022

Thanks @lsetiawan ! I will leave that section in for future use. :)

Thinking about it, I wonder if we can add like specific connected modules that should also be run for that module if it uses functions from those connected modules. Does that make sense? 😆 This way, we can have an "extensive" test without having to run the whole test!

@leewujung
Copy link
Member Author

Thinking about it, I wonder if we can add like specific connected modules that should also be run for that module if it uses functions from those connected modules. Does that make sense? 😆 This way, we can have an "extensive" test without having to run the whole test!

Definitely worth discussion as part of #552! This seems would fall in line with the integration test.

@emiliom
Copy link
Collaborator

emiliom commented Mar 28, 2022

How about also removing raw2nc and raw2zarr in this PR, too? That would take care of all the old API's, I think.

@leewujung
Copy link
Member Author

@emiliom : thanks for finding the raw2nc and raw2zarr, somehow I saw them in the docs but it did not register for me to remove them. I'll push up new commits to remove them.

Also, I think it's fine to remove the reference to old API altogether. Our docs are versioned so folks can hopefully find what they need if they really wanted to use the old versions. I'll make these changes in the docs also.

@emiliom
Copy link
Collaborator

emiliom commented Mar 29, 2022

I think this is ready to merge. Thanks for pursuing this! Good riddance 😆

@leewujung leewujung merged commit 57a4228 into OSOceanAcoustics:dev Mar 29, 2022
@leewujung leewujung deleted the remove-old-api branch May 27, 2022 04:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

4 participants