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

Remove label parameter from pcv.transform.detect_color_card and auto_correct_color in v5.0 #1660

Open
HaleySchuhl opened this issue Jan 23, 2025 · 10 comments
Assignees
Labels
bug Bug or potential bug reports cleanup Code quality updates update Updates an existing feature/method
Milestone

Comments

@HaleySchuhl
Copy link
Contributor

HaleySchuhl commented Jan 23, 2025

Describe the bug
Remove unused label parameter from pcv.transform.detect_color_card and auto_correct_color. Since this is a breaking change, add to v5.0 release.

To Reproduce
Old color correction tutorial breaks when used with v4.6

Expected behavior
No unused inputs, so remove from the function and reflect this change in documentation page. Show the new syntax for calling color chip size now that it is a metadata term (per image) and not an observation (per object).

  • PlantCV Version [4.6.0]

Additional context
The reason we didn't realize the label parameter is never used is because it's techincally getting used just from us checking whether it is None or not.

if label is None:
        label = params.sample_label

Thanks to @eseigeldanf for bringing this bug to our attention while updating tutorials.

@HaleySchuhl HaleySchuhl added bug Bug or potential bug reports cleanup Code quality updates update Updates an existing feature/method labels Jan 23, 2025
@HaleySchuhl HaleySchuhl added this to the PlantCV v4.7 milestone Jan 23, 2025
@github-project-automation github-project-automation bot moved this to New Issues in PlantCV4 Jan 23, 2025
@HaleySchuhl
Copy link
Contributor Author

@all-contributors please add @eseigeldanf for bug, tutorial, documentation

@all-contributors please add @trogers623 for tutorial, documentation

@all-contributors please add @Sunitalama2 for tutorial, documentation

Copy link
Contributor

@HaleySchuhl

I've put up a pull request to add @eseigeldanf! 🎉

@HaleySchuhl
Copy link
Contributor Author

@all-contributors please add @trogers623 for tutorial, documentation

Copy link
Contributor

@HaleySchuhl

I've put up a pull request to add @trogers623! 🎉

@HaleySchuhl
Copy link
Contributor Author

@all-contributors please add @Sunitalama2 for tutorial, documentation

Copy link
Contributor

@HaleySchuhl

I've put up a pull request to add @Sunitalama2! 🎉

@HaleySchuhl
Copy link
Contributor Author

Doing these one at a time now, thanks to the new contributors 👏

@all-contributors please add @Sunitalama2 for tutorial, documentation

Copy link
Contributor

@HaleySchuhl

@Sunitalama2 already contributed before to tutorial, doc

@HaleySchuhl
Copy link
Contributor Author

@all-contributors please add @clhendrikse for tutorial, documentation

Copy link
Contributor

@HaleySchuhl

I've put up a pull request to add @clhendrikse! 🎉

@HaleySchuhl HaleySchuhl changed the title Remove label parameter from pcv.transform.detect_color_card and auto_correct_color Remove label parameter from pcv.transform.detect_color_card and auto_correct_color in v5.0 Jan 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Bug or potential bug reports cleanup Code quality updates update Updates an existing feature/method
Projects
Status: New Issues
Development

No branches or pull requests

1 participant