Skip to content

Conversation

@cadenmyers13
Copy link
Contributor

@cadenmyers13 cadenmyers13 commented Feb 3, 2026

closes #376

@cadenmyers13 cadenmyers13 mentioned this pull request Feb 3, 2026
@codecov
Copy link

codecov bot commented Feb 3, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (3f9ae8e) to head (1c6bcda).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main      #377   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            9        10    +1     
  Lines          516       567   +51     
=========================================
+ Hits           516       567   +51     
Files with missing lines Coverage Δ
tests/test_deprecator.py 100.00% <100.00%> (ø)
tests/test_loaddata.py 100.00% <100.00%> (ø)
tests/test_serialization.py 100.00% <100.00%> (ø)
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@cadenmyers13
Copy link
Contributor Author

@sbillinge ready for review/merge. I also added a light tests for the deprecator just to be thorough

Copy link
Contributor

@sbillinge sbillinge left a comment

Choose a reason for hiding this comment

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

please see comments

)


def generate_deprecation_docstring(new_name, removal_version, new_base=None):
Copy link
Contributor

Choose a reason for hiding this comment

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

why did you remove this?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It isnt used anywhere. my idea with it was to have it as a helper that could easily print the docstring then the user could copy/paste the docstring where it needs to go. I removed it because I felt like this was overkill but if you think its helpful we can add it back

Copy link
Contributor

Choose a reason for hiding this comment

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

I wrote it because I was hoping for more uniformity. You could just print the docstring template and use it.



def build_deprecation_message(
def deprecation_message(
Copy link
Contributor

Choose a reason for hiding this comment

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

don't we want our function names to be verbs not nouns? I think I prefer build_deprecation_message?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@sbillinge Okay we can change this

@cadenmyers13
Copy link
Contributor Author

@sbillinge ready for review again

@sbillinge
Copy link
Contributor

@cadenmyers13 ok, I left a comment. Everything else looks fine. Thanks for getting the verb-name function going.

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.

3 participants