docs: correct Args section in UiPathExecutionRuntime.stream docstring - #166
Open
Avicennasis wants to merge 1 commit into
Open
docs: correct Args section in UiPathExecutionRuntime.stream docstring#166Avicennasis wants to merge 1 commit into
Avicennasis wants to merge 1 commit into
Conversation
There was a problem hiding this comment.
🟢 Approval recommended
The change is a straightforward docstring correction that matches the method signature and introduces no functional or API changes.
Pull request overview
This PR corrects the Args: section of the UiPathExecutionRuntime.stream() docstring so it matches the method’s actual signature in the runtime SDK.
Changes:
- Replaced incorrect
runtime/contextparameters in the docstring withinput/options. - Aligned the
optionsdescription with theUiPathStreamOptionsdocstring (“Streaming-specific execution options”).
File summaries
| File | Description |
|---|---|
| src/uipath/runtime/base.py | Fixes UiPathExecutionRuntime.stream() docstring parameter documentation to match the real method signature. |
Review details
- Files reviewed: 1/1 changed files
- Comments generated: 0
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
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
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.
Summary
Fix 1 copy-paste error in a docstring:
Args:section ofUiPathExecutionRuntime.stream()documentedruntimeandcontext, neither of which is a parameter of the method. The actual signature isstream(self, input: dict[str, Any] | None = None, options: UiPathStreamOptions | None = None), so the section now documentsinputandoptions.The
optionsdescription mirrors theUiPathStreamOptionsclass docstring ("Streaming-specific execution options").No functional changes - docstring only. No identifiers were renamed.