Describe GUI behavior #57
Merged
Conversation
This file contains hidden or 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
Contributor
There was a problem hiding this comment.
Pull Request Overview
This pull request updates the API interface documentation for the astro image display to better describe the expected GUI behavior. It enhances docstrings by adding "Notes" sections to clarify how methods affect the display of images and markers.
- Improved documentation in load_image, set_cuts, get_cuts, set_stretch, get_stretch, set_colormap, get_colormap, save, load_catalog, set_catalog_style, get_catalog_style, get_catalog, get_catalog_names, set_viewport, and get_viewport methods.
- Added guidance on which methods update the image display and which do not.
Comments suppressed due to low confidence (1)
src/astro_image_display_api/interface_definition.py:53
- [nitpick] Consider clarifying what criteria or parameters define an 'appropriate viewport' to set clearer expectations for implementers.
Loading an image should also set an appropriate viewport for that image.
mwcraig
force-pushed
the
add-gui-effects-to-docstrings
branch
from
7478fb8 to
bd983c8
Compare
mwcraig
force-pushed
the
add-gui-effects-to-docstrings
branch
from
bd983c8 to
48a205d
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Fixes #51