deprecator

[sbillinge]

• feat: docstring generator function
• news

[github-actions]

Warning! No news item is found for this PR. If this is a user-facing
change/feature/fix,
please add a news item by copying the format from news/TEMPLATE.rst.
For best practices, please visit
https://scikit-package.github.io/scikit-package/snippets/news-file-format.html#how-do-i-create-a-news-file.

[codecov]

Codecov Report

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

Additional details and impacted files

@@            Coverage Diff            @@
##              main      #373   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            9         9           
  Lines          516       516           
=========================================
  Hits           516       516           

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[sbillinge]

@cadenmyers13 I think this might be ready for testing. If it is easier I can merge it and we can test it. I intend to merge this into main and we can push out a release with a patch bump so that the deprecator is available to everyone. Then we can work on the actual deprecations on the v3.7.0 branch and push out a minor bump with those.

[cadenmyers13]

@sbillinge This one would be easy for you to test locally before merging if you want. If you install your branch locally with pip install . then create a new python file and try to load in a random .gr file somewhere on your computer the dep warning should show. Im also okay with you merging and I can test it, its up to you.

I intend to merge this into main and we can push out a release with a patch bump so that the deprecator is available to everyone.

Yes, this sounds perfect. Lets get this rolling!