You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Is your feature request related to a problem? Please describe.
This request is to support word wrapping in types for parameters/attributes/...
Describe the solution you'd like
"""... Parameters ---------- choices: Union[Dict[:class:`str`, Union[:class:`str`, :class:`int`, :class:`float`]], Iterable[Union[:class:`str`, :class:`int`, :class:`float`]]] A list of choices that a user must choose. ... """
Describe alternatives you've considered
I am aware type aliases are possible, but sometimes it is not worth making a whole alias for one type.
Additional context
This is the current result, a - in the middle where the wrap took place.
The text was updated successfully, but these errors were encountered:
Unfortunately, the type will still be rendered on a single line which may then become quite long. Instead, I would suggest using a type annotation and from __future__ import annotations directly because:
you can use shorter Python syntax like dict[str, str | int] directly.
the references are usually well found unless they are guarded by a if TYPE_CHECKING block. In there are imports there, I don't think they will be all found (especially if there are aliases).
Is your feature request related to a problem? Please describe.
This request is to support word wrapping in types for parameters/attributes/...
Describe the solution you'd like
Describe alternatives you've considered
I am aware type aliases are possible, but sometimes it is not worth making a whole alias for one type.
Additional context

This is the current result, a
-
in the middle where the wrap took place.The text was updated successfully, but these errors were encountered: