docs: improve UbTtsProvider docstrings with complete parameter documentation#1495
Merged
openminddev merged 12 commits intoOpenMind:mainfrom Feb 15, 2026
Merged
Conversation
Contributor
|
@XieNBi Dataclass fields should use |
…hub.com/XieNBi/OM1 into docs/improve-ub-tts-provider-docstrings
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
0xbyt4
approved these changes
Feb 10, 2026
Wanbogang
approved these changes
Feb 10, 2026
Replace the 'Attributes' header with 'Parameters' in the UbTtsProvider class docstring to correctly label the tts_url entry and align the docstring with parameter-section conventions.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Documented the
UbTtsProviderclass and its methods with complete parameter documentation.__init__method parametersspeak()method docstring with complete Parameters, Returns, and Notes sectionsget_tts_status()method docstring with detailed status value descriptions