Skip to content

fix!: rename ShuttersWidget -> ShutterWidget - #561

Open
gselzer wants to merge 2 commits into
pymmcore-plus:mainfrom
gselzer:shutter-widget-rename
Open

gselzer wants to merge 2 commits into
pymmcore-plus:mainfrom
gselzer:shutter-widget-rename

Conversation

@gselzer

@gselzer gselzer commented Jul 20, 2026

Copy link
Copy Markdown
Contributor

The name ShuttersWidget is misleading, because it only can control one shutter (I suppose if the autoshutter checkbox is enabled and the autoshutter wasn't the one this button controls, then it controls two, but I think that's a different problem). We should rename the widget to avoid misunderstanding (as I did for like 15 minutes 🙃)

Note that this would be a breaking change - do we want to add in compatibility shims, given that we'll bump the minor version anyways?

The name ShuttersWidget is misleading, because it only can control one
shutter
@codecov

codecov Bot commented Jul 20, 2026 •

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 60.00000% with 2 lines in your changes missing coverage. Please review.
✅ Project coverage is 87.35%. Comparing base (d61a158) to head (55a8aa2).

Files with missing lines Patch % Lines
src/pymmcore_widgets/__init__.py 33.33% 2 Missing ⚠️

❌ Your patch check has failed because the patch coverage (60.00%) is below the target coverage (85.00%). You can increase the patch coverage or adjust the target coverage.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #561      +/-   ##
==========================================
- Coverage   87.36%   87.35%   -0.02%     
==========================================
  Files         115      115              
  Lines       14098    14101       +3     
==========================================
+ Hits        12317    12318       +1     
- Misses       1781     1783       +2     

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@tlambert03

tlambert03 commented Jul 21, 2026 •

Copy link
Copy Markdown
Member

@fdrgsp, do you have any recollection on the naming logic here?

@gselzer, since this is a breaking change that is largely just cosmetic, i'm not in a hurry to get this in. (I agree that it's slightly misleading, but it's also not so bad that I immediately want to break all downstream usage of it... I would definitely want a shim in the meantime if we do do it)

@fdrgsp

fdrgsp commented Jul 21, 2026

Copy link
Copy Markdown
Collaborator

@fdrgsp, do you have any recollection on the naming logic here?

@tlambert03 not in particular, It has been a long time since I worked an that...I guess it was my mistake as python beginner 😅

@gselzer

gselzer commented Jul 21, 2026

Copy link
Copy Markdown
Contributor Author

@gselzer, since this is a breaking change that is largely just cosmetic, i'm not in a hurry to get this in.

Nor am I, I just got confused and wanted to record the complaint/propose an eventual fix. I can get by without this change in the meantime, for sure. How about we leave this PR open for now, and evaluate on the next release what to do with this?

This branch has not been deployed

No deployments
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.

3 participants