Skip to content

doc(scenariod): improve docstring of scenariod#2379

Draft
kevinmessiaen wants to merge 1 commit intomainfrom
chore/refresh-python-doc
Draft

doc(scenariod): improve docstring of scenariod#2379
kevinmessiaen wants to merge 1 commit intomainfrom
chore/refresh-python-doc

Conversation

@kevinmessiaen
Copy link
Copy Markdown
Member

Description

Related Issue

Type of Change

  • 📚 Examples / docs / tutorials / dependencies update
  • 🔧 Bug fix (non-breaking change which fixes an issue)
  • 🥂 Improvement (non-breaking change which improves an existing feature)
  • 🚀 New feature (non-breaking change which adds functionality)
  • 💥 Breaking change (fix or feature that would cause existing functionality to change)
  • 🔐 Security fix

Checklist

  • I've read the CODE_OF_CONDUCT.md document.
  • I've read the CONTRIBUTING.md guide.
  • I've written tests for all new methods and classes that I created.
  • I've written the docstring in NumPy format for all the methods and classes that I created or modified.
  • I've updated the uv.lock running uv lock (only applicable when pyproject.toml has been
    modified)
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

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.

Suggested change
inputs : InputGenerator | Generator | Callable
inputs : InputType | InputGenerator | Generator | Callable
@kevinmessiaen kevinmessiaen self-assigned this Apr 14, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

1 participant