Documentation and API cleanups on Image #2348
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
freakboy3742
force-pushed
the
image-tweaks
branch
from
47a1533
to
08ba9df
Compare
mhsmith
approved these changes
Jan 17, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Modifies the constructor for Image to better handle the backwards compatibility path, and provide a less confusing type annotation.
Also takes the opportunity to introduce canonical documentation on the difference between Image and Icon. I'm very slightly softening on the idea of adding an
on_presshandler to ImageView (to support the "Image Gallery" use case); in the meantime, these admonitions explain the status quo. If we addImageView.on_pressin the future, the admonitions will need to be updated to say that you can make ImageView interactive, but if what you're looking for is a fancy button, please don't.Fixes #2347.
PR Checklist: