Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix issue in stubs where step decorators dont have any parameters #2313

Merged
merged 1 commit into from
Feb 28, 2025

Conversation

talsperre
Copy link
Collaborator

If we have a decorator like @my_deco which does not have any parameters section in the docstring, then the generated stubs are wrong since it adds an empty Parameters section like the one shown below:

@typing.overload
def my_deco(f: typing.Callable[[FlowSpecDerived, StepFlag], None]) -> typing.Callable[[FlowSpecDerived, StepFlag], None]:
    """
    My function docstring
    
    Parameters
    ----------
    """

This causes issues when rendering the docs using mkdocs.

@savingoyal savingoyal merged commit ea236a2 into master Feb 28, 2025
28 checks passed
@savingoyal savingoyal deleted the dev/update-stubs branch February 28, 2025 21:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants