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

Deprecate some analysis functions #207

Merged

Conversation

freemansw1
Copy link
Member

As discussed in #146 (and similar to #200), this deprecates three functions in analysis.py: cell_statistics_all, cell_statistics, and cog_cell. These functions likely don't work and should be reworked in any event before 2.0.

  • Have you followed our guidelines in CONTRIBUTING.md?
  • Have you self-reviewed your code and corrected any misspellings?
  • Have you written documentation that is easy to understand?
  • Have you written descriptive commit messages?
  • Have you added NumPy docstrings for newly added functions?
  • Have you formatted your code using black?
  • If you have introduced a new functionality, have you added adequate unit tests?
  • Have all tests passed in your local clone?
  • If you have introduced a new functionality, have you added an example notebook?
  • Have you kept your pull request small and limited so that it is easy to review?
  • Have the newest changes from this branch been merged?

@freemansw1 freemansw1 added this to the Version 1.5 milestone Nov 21, 2022
@freemansw1 freemansw1 added the Refactor Code that doesn't intend to change the functionality, but instead refactor/clean up. label Nov 21, 2022
@freemansw1 freemansw1 linked an issue Nov 21, 2022 that may be closed by this pull request
@codecov
Copy link

codecov bot commented Nov 21, 2022

Codecov Report

Base: 39.03% // Head: 39.01% // Decreases project coverage by -0.02% ⚠️

Coverage data is based on head (672abbc) compared to base (7e961e6).
Patch coverage: 25.00% of modified lines in pull request are covered.

Additional details and impacted files
@@              Coverage Diff              @@
##           RC_v1.5.0     #207      +/-   ##
=============================================
- Coverage      39.03%   39.01%   -0.03%     
=============================================
  Files             11       11              
  Lines           2262     2266       +4     
=============================================
+ Hits             883      884       +1     
- Misses          1379     1382       +3     
Flag Coverage Δ
unittests 39.01% <25.00%> (-0.03%) ⬇️

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

Impacted Files Coverage Δ
tobac/analysis.py 8.15% <25.00%> (+0.24%) ⬆️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

Copy link
Collaborator

@snilsn snilsn left a comment

Choose a reason for hiding this comment

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

Agree with the deprecation of these functions @freemansw1 . Approving this PR

Copy link
Member

@JuliaKukulies JuliaKukulies left a comment

Choose a reason for hiding this comment

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

Me, too! Happy for you to merge as soon as you are ready @freemansw1

@freemansw1 freemansw1 merged commit 2ed79b0 into tobac-project:RC_v1.5.0 Nov 29, 2022
@freemansw1 freemansw1 deleted the deprecate_analysis_functions branch November 29, 2022 17:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Refactor Code that doesn't intend to change the functionality, but instead refactor/clean up.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

The future of analysis.py functions
3 participants