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

Deprecated DataSet.to_reciprocalgrid() should call DataSet.to_reciprocal_grid() #285

Merged
merged 1 commit into from
Dec 10, 2024

Conversation

JBGreisman
Copy link
Member

This is a very minor bookkeeping PR -- we currently have two function for converting a DataSet to a 3D numpy array representing the underlying data: DataSet.to_reciprocalgrid() and DataSet.to_reciprocal_grid(). The former will be deprecated in favor of the latter, in order to have consistency naming schemes in terms of underscores.

However, we currently have duplicate implementations for both functions. If we want to edit the implementations before we officially remove one of them, we will need to make changes in both places. This PR updates the deprecated code to call the newer version to avoid needing to maintain the code in two places.

@JBGreisman JBGreisman added the API Interface Decisions label Dec 4, 2024
@JBGreisman JBGreisman requested a review from kmdalton December 4, 2024 18:54
@codecov-commenter
Copy link

codecov-commenter commented Dec 4, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.93%. Comparing base (01286d8) to head (75c0466).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #285      +/-   ##
==========================================
- Coverage   88.98%   88.93%   -0.05%     
==========================================
  Files          40       40              
  Lines        2841     2830      -11     
==========================================
- Hits         2528     2517      -11     
  Misses        313      313              
Flag Coverage Δ
unittests 88.93% <100.00%> (-0.05%) ⬇️

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

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

Copy link
Member

@kmdalton kmdalton left a comment

Choose a reason for hiding this comment

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

This looks good to me. Sorry I missed this in my feed.

@kmdalton kmdalton merged commit f204463 into main Dec 10, 2024
10 checks passed
@kmdalton kmdalton deleted the deprecation branch December 10, 2024 15:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
API Interface Decisions
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants