Remove image_height and image_width attributes; test that every method/attribute has docs
#77
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 PR removes the now-unnecessary image_width and image_height attributes from the interface and implementation, and adds enforcement that every method/property has a docstring via a new decorator and tests.
- Deleted
image_width/image_heightfrom the protocol and logic classes. - Introduced
docs_from_interfacedecorator to copy docstrings from the interface. - Added tests ensuring all interface methods/attributes have docs.
- Replaced hard-coded image dimensions in tests with
DEFAULT_IMAGE_SHAPE.
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| tests/test_astro_image_display_api.py | Added test_every_method_attribute_has_docstring. |
| src/astro_image_display_api/interface_definition.py | Removed image_width and image_height attributes from protocol. |
| src/astro_image_display_api/image_viewer_logic.py | Added docs_from_interface decorator; removed manual __doc__ assignments. |
| src/astro_image_display_api/api_test.py | Introduced DEFAULT_IMAGE_SHAPE; updated fixtures and tests; removed width/height tests. |
Comments suppressed due to low confidence (2)
src/astro_image_display_api/api_test.py:21
- [nitpick] The tuple
DEFAULT_IMAGE_SHAPEis ambiguous (height vs width); consider using separate constants or renaming (e.g.DEFAULT_IMAGE_HEIGHTandDEFAULT_IMAGE_WIDTH) for clarity.
DEFAULT_IMAGE_SHAPE = (100, 150)
src/astro_image_display_api/image_viewer_logic.py:56
- The decorator references
ImageViewerInterfacebut there’s no import in this file; please addfrom astro_image_display_api.interface_definition import ImageViewerInterfaceat the top.
def docs_from_interface(cls):
| ) | ||
|
|
||
|
|
||
| def test_every_method_attribute_has_docstring(): |
There was a problem hiding this comment.
[nitpick] This test is duplicated in api_test.py; consider extracting a shared helper or fixture to avoid copy–paste.
Member
Author
There was a problem hiding this comment.
That is deliberate. One is used internally, one is meant to be used externally.
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.
This removes the
image_heightandimage_widthproperties. These things are determined by the image that is loaded.This also checks that every method/property in the interface and the sample implementation has a docstring.