-
Notifications
You must be signed in to change notification settings - Fork 3
(docs)[python-sdk]: Added specs documentation for the Gui service #99
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
base: ketryx
Are you sure you want to change the base?
Conversation
93bed1d
to
461fa47
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
…Added specs documentation for the Gui service
461fa47
to
0000f7a
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, some small comments but otherwise great
|
||
**itemId**: SPEC-GUI-SERVICE | ||
**itemType**: Software Item Spec | ||
**itemFulfills**: SWR-SYSTEM-GUI-INTERFACE-1 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
where is this SWR from?
# Auto-discovery pattern with conditional loading | ||
if find_spec("nicegui"): | ||
from ._error import PageBuilder as ErrorPageBuilder | ||
from ._frame import HEALTH_UPDATE_INTERVAL, USERINFO_UPDATE_INTERVAL, frame |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
USERINFO_UPDATE_INTERVAL is not exported in all despite being mentioned as exported, i dont know if it matters, resolve if not
## Appendix A: Verified Implementation Status | ||
|
||
| Component | Implementation Status | Evidence Location | | ||
|-----------|----------------------|-------------------| | ||
| Frame Component | ✅ Complete | `_frame.py` | | ||
| Theme Component | ✅ Complete | `_theme.py` | | ||
| Error Handler | ✅ Complete | `_error.py` | | ||
| CLI Integration | ✅ Complete | `cli.py` | | ||
| Auto-Discovery | ✅ Complete | `__init__.py` | | ||
| WSI GUI Pattern | ✅ Complete | `wsi/_gui.py` | | ||
| QuPath GUI Pattern | ✅ Complete | `qupath/_gui.py` | | ||
| Configuration Constants | ✅ Complete | `_frame.py` | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
are we planning to update this with components that are not yet implemented?
Create Software Item Specification for GUI service following the QuPath specification format.
Acceptance Criteria:
SPEC-{MODULE_NAME_UPPER}-SERVICE.md
in project rootSPEC-GUI-SERVICE.md