Skip to content

Option for display mode of Optional[Union]. #10773

@Sangwon91

Description

@Sangwon91

Is your feature request related to a problem? Please describe.
If I use typehints like this, I get the same result as expected from the documentation.

in code:

def func(value: int | str)
    pass

in documentation:

value (int | str) - description about value.

But adding None converts it to a hard-to-read form.
in code:

def func(value: int | str | None = None)
    pass

in documentation:

value (Optional[Union[int, str]]) - description about value.

I think the output should look like this.

value (int | str | None) - description about value.

Does Sphinx already have these features? If not, it would be nice if Sphinx implemented such a feature.

Metadata

Metadata

Assignees

No one assigned

    Labels

    type:enhancementenhance or introduce a new feature

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions