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

Update warn to utilize the verbose global parameter #1600

Merged
merged 4 commits into from
Sep 26, 2024
Merged

Conversation

nfahlgren
Copy link
Member

@nfahlgren nfahlgren commented Sep 17, 2024

Describe your changes
The existing warn function prints a warning message to STDERR. This PR updates the function to print when pcv.params.verbose is True but not False. This allows the user to suppress warning messages when needed. Also adds an explicit test for the warn function.

Type of update
Is this a: New feature or feature enhancement

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

@nfahlgren nfahlgren added enhancement Enhancements to existing features ready to review labels Sep 17, 2024
@nfahlgren nfahlgren added this to the PlantCV v4.6 milestone Sep 17, 2024
Copy link

deepsource-io bot commented Sep 17, 2024

Here's the code health analysis summary for commits 1429294..6692372. 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 self-requested a review September 26, 2024 17:00
@nfahlgren nfahlgren merged commit 18462e5 into main Sep 26, 2024
5 checks passed
@nfahlgren nfahlgren deleted the add-verbose-warn branch September 26, 2024 18:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Enhancements to existing features ready to review
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants