docs: Improve OnlineTool docstring for clarity #2037
+3
−3
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.
Changes
Updated the module docstring in
qlib/workflow/online/utils.py
to improve readability and grammar. This text renders as the intro paragraph in the "Online Tool" docs section (via automodule indocs/component/online.rst
).Original (awkward phrasing):
Updated:
Why?
Enhances clarity and flow without altering technical meaning. No functional code changes.
Testing
Local Sphinx build confirmed the update renders correctly in
component/online.html
. No breaking changes.Related
Improves https://qlib.readthedocs.io/en/latest/component/online.html