-
Notifications
You must be signed in to change notification settings - Fork 4
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
feat:loading_status_templates #151
Conversation
extracted from system PHAL for re-use and uncoupling of GUI resources from skills/plugins companion PR OpenVoiceOS/ovos-gui#68
WalkthroughThe pull request adds two new methods to the Changes
Sequence DiagramsequenceDiagram
participant Client
participant GUIInterface
participant GUI
Client->>GUIInterface: show_loading_animation(text)
GUIInterface->>GUI: Set session data
GUIInterface->>GUI: Show "SYSTEM_Loading" page
Client->>GUIInterface: show_status_animation(text, success)
GUIInterface->>GUI: Set session data
GUIInterface->>GUI: Show "SYSTEM_Status" page
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## dev #151 +/- ##
==========================================
+ Coverage 39.49% 42.28% +2.79%
==========================================
Files 17 16 -1
Lines 1732 2185 +453
==========================================
+ Hits 684 924 +240
- Misses 1048 1261 +213 ☔ View full report in Codecov by Sentry. |
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.
Actionable comments posted: 0
🧹 Nitpick comments (2)
ovos_bus_client/apis/gui.py (2)
516-535
: Consider adding unit tests or error handling for input parameters
These lines introduce a newshow_loading_animation
method that correctly accepts both integers and booleans foroverride_idle
. However, it does not verify thattext
is non-empty or otherwise valid, nor does it handle non-boolean/integer values foroverride_idle
. To improve robustness, consider validating these inputs, or at least clarifying assumptions in the docstring. Also, adding unit tests to ensure correct behavior under various overrides (e.g., indefinite vs. timed vs. default) would help maintain correctness.
535-555
: Refine success/failure states to improve clarity
Inshow_status_animation
, the choice of"Enabled"
vs."Disabled"
forself["status"]
is semantically correct for QML but may be ambiguous to readers of the code. If appropriate for the platform, consider using states like"Success"
/"Failure"
or updating the docstring to clarify that"Enabled"
maps to success and"Disabled"
maps to failure. Also, as withshow_loading_animation
, consider adding unit tests to ensure these outcomes display correctly in the UI.
* feat:loading_status_templates companion PR OpenVoiceOS/ovos-bus-client#151 * feat:loading_status_templates companion PR OpenVoiceOS/ovos-bus-client#151
extracted from system PHAL for re-use and uncoupling of GUI resources from skills/plugins
companion PR OpenVoiceOS/ovos-gui#68
Summary by CodeRabbit