doc(scenariod): improve docstring of scenariod#2379
doc(scenariod): improve docstring of scenariod#2379kevinmessiaen wants to merge 1 commit intomainfrom
Conversation
There was a problem hiding this comment.
Code Review
This pull request focuses on enhancing the documentation for the Scenario and ScenarioRunner classes by adding missing parameter descriptions, updating type hints, and clarifying return types across several methods. Specifically, it documents the annotations and target fields and updates the interact, with_annotations, with_target, and run methods. A review comment identifies an inconsistency in the interact method's docstring where InputType was removed from the inputs parameter type hint, which should be restored to accurately reflect support for static values.
| The input specification for the interaction. | ||
| outputs : OutputType | Callable | ||
| The output specification for the interaction. | ||
| inputs : InputGenerator | Generator | Callable |
There was a problem hiding this comment.
The type hint for the inputs parameter in the docstring is missing InputType to represent static values. The description on the following line correctly mentions "static value", but the type hint itself is incomplete. To ensure the docstring is accurate and clear for users, please add InputType to the union.
| inputs : InputGenerator | Generator | Callable | |
| inputs : InputType | InputGenerator | Generator | Callable |
Description
Related Issue
Type of Change
Checklist
CODE_OF_CONDUCT.mddocument.CONTRIBUTING.mdguide.uv.lockrunninguv lock(only applicable whenpyproject.tomlhas beenmodified)