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

Add deprecation warning about label from the detect color card function #1664

Open
wants to merge 13 commits into
base: main
Choose a base branch
from

Conversation

HaleySchuhl
Copy link
Contributor

@HaleySchuhl HaleySchuhl commented Jan 23, 2025

Describe your changes
Adds a deprecation warning that we plan to remove the label parameter input from detect_color_card and auto_correct_color (since the trait of chip size is now a metadata term and therefore doesn't utilize a label).

Type of update
Is this a:

  • Bug fix
  • feature enhancement

Associated issues

Additional context
Technically a breaking change compared to before the chip size was converted to a metadata term.

For the reviewer
See this page for instructions on how to review the pull request.

  • PR functionality reviewed in a Jupyter Notebook
  • All tests pass
  • Test coverage remains 100%
  • Documentation tested
  • New documentation pages added to plantcv/mkdocs.yml
  • Changes to function input/output signatures added to updating.md
  • Code reviewed
  • PR approved

@HaleySchuhl HaleySchuhl added bugfix Bug fixes ready to review update Updates an existing feature/method cleanup Code quality updates labels Jan 23, 2025
@HaleySchuhl HaleySchuhl added this to the PlantCV v4.7 milestone Jan 23, 2025
Copy link

deepsource-io bot commented Jan 23, 2025

Here's the code health analysis summary for commits 4995a6e..1d1d7c7. View details on DeepSource ↗.

Analysis Summary

AnalyzerStatusSummaryLink
DeepSource Python LogoPython✅ SuccessView Check ↗
DeepSource Test coverage LogoTest coverage✅ SuccessView Check ↗

Code Coverage Report

MetricAggregatePython
Branch Coverage100%100%
Composite Coverage100%100%
Line Coverage100%100%
New Branch Coverage100%100%
New Composite Coverage100%100%
New Line Coverage100%, ✅ Above Threshold100%, ✅ Above Threshold

💡 If you’re a repository administrator, you can configure the quality gates from the settings.

@HaleySchuhl HaleySchuhl requested a review from k034b363 January 24, 2025 16:51
@HaleySchuhl HaleySchuhl added work in progress Mark work in progress and removed ready to review labels Jan 24, 2025
@HaleySchuhl HaleySchuhl added ready to review and removed work in progress Mark work in progress labels Jan 24, 2025
@HaleySchuhl HaleySchuhl changed the title Remove label from the detect color card function Add deprecation warning about label from the detect color card function Jan 28, 2025
@HaleySchuhl HaleySchuhl self-assigned this Jan 30, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bugfix Bug fixes cleanup Code quality updates ready to review update Updates an existing feature/method
Projects
Status: Pull Requests
Development

Successfully merging this pull request may close these issues.

2 participants