Skip to content

Raises and Yields directives are not shown correctly #172

Description

@LysandreJik

Both Raises and `Yields directives are currently not shown in the documentation:

        """
        Call HF API to sign in a user and get a token if credentials are valid.

        <Tip>

        Warning: Deprecated, will be removed in v0.7. Please use
        [`HfApi.set_access_token`] instead.

        </Tip>

        Args:
            username (`str`):
                The username of the account with which to login.
            password (`str`):
                The password of the account with which to login.

        Returns:
            `str`: token if credentials are valid

        Raises:
            [`HTTPError`](https://2.python-requests.org/en/master/api/#requests.HTTPError) if credentials are invalid
        """

Is shown as
image

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions