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

Raises and Yields directives are not shown correctly #172

Closed
LysandreJik opened this issue Mar 31, 2022 · 0 comments · Fixed by #141
Closed

Raises and Yields directives are not shown correctly #172

LysandreJik opened this issue Mar 31, 2022 · 0 comments · Fixed by #141

Comments

@LysandreJik
Copy link
Member

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

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 a pull request may close this issue.

1 participant