Skip to content

Type hints rendering issue #2056

@vict0rsch

Description

@vict0rsch

My function looks like:

def prompt(message: str, default: str = None) -> str:
    """Prompt the user for a value.

    Parameters
    ----------
    message : str
        The message to prompt the user with.
    default : str, optional
        The default value, by default None.

    Returns:
    --------
    str
        The value entered by the user.
    """
    text = f"{message} [{default}]" if default else message
    return input(text).strip() or default

The intermediate autoapi file contains:

.. py:function:: prompt(message: str, default: str = None) -> str

   Prompt the user for a value.

   Parameters
   ----------
   message : str
       The message to prompt the user with.
   default : str, optional
       The default value, by default None.

   Returns:
   --------
   str
       The value entered by the user.

However the rendered HTML has an issue between the variable names and their types:

image

Metadata

Metadata

Assignees

Labels

bugSomething isn't working

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions