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

refactor(collate): deprecationwarning for collate #462

Merged
merged 3 commits into from
Nov 6, 2024

Conversation

d33bs
Copy link
Member

@d33bs d33bs commented Oct 18, 2024

Description

This adds a DeprecationWarning to collate with guidance on replacements which may suit a person's possible needs. I did my best to suppress warnings when testing; one deprecation warning of about 8 total is still emitted though I'm not certain how. I opted to focus on getting the message in place here, as the warning here will also be removed eventually.

Thanks for any feedback!

Closes #459

What is the nature of your change?

  • Bug fix (fixes an issue).
  • Enhancement (adds functionality).
  • Breaking change (fix or feature that would cause existing functionality to not work as expected).
  • This change requires a documentation update.

Checklist

Please ensure that all boxes are checked before indicating that a pull request is ready for review.

  • I have read the CONTRIBUTING.md guidelines.
  • My code follows the style guidelines of this project.
  • I have performed a self-review of my own code.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have made corresponding changes to the documentation.
  • My changes generate no new warnings.
  • New and existing unit tests pass locally with my changes.
  • I have added tests that prove my fix is effective or that my feature works.
  • I have deleted all non-relevant text in this pull request template.

@codecov-commenter
Copy link

codecov-commenter commented Oct 18, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.74%. Comparing base (e8880bc) to head (3cb971c).
Report is 13 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #462   +/-   ##
=======================================
  Coverage   94.74%   94.74%           
=======================================
  Files          57       57           
  Lines        3156     3156           
=======================================
  Hits         2990     2990           
  Misses        166      166           
Flag Coverage Δ
unittests 94.74% <100.00%> (ø)

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.

@d33bs d33bs marked this pull request as ready for review October 18, 2024 21:12
Copy link
Member

@kenibrewer kenibrewer left a comment

Choose a reason for hiding this comment

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

LGTM! Thanks for adding!

Copy link
Member

@gwaybio gwaybio left a comment

Choose a reason for hiding this comment

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

👍

pycytominer/cyto_utils/collate.py Outdated Show resolved Hide resolved
@d33bs
Copy link
Member Author

d33bs commented Nov 6, 2024

Thanks @kenibrewer and @gwaybio ! Merging this in.

@d33bs d33bs merged commit 04607e6 into cytomining:main Nov 6, 2024
12 checks passed
@d33bs d33bs deleted the collate-deprecation-notice branch November 6, 2024 22:57
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.

Add deprecation notice for collate
4 participants