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

docs: return values don't show up in docs #1293

Open
MarcoGorelli opened this issue Oct 31, 2024 · 1 comment
Open

docs: return values don't show up in docs #1293

MarcoGorelli opened this issue Oct 31, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation high priority

Comments

@MarcoGorelli
Copy link
Member

No description provided.

@MarcoGorelli MarcoGorelli added documentation Improvements or additions to documentation high priority labels Oct 31, 2024
@MarcoGorelli
Copy link
Member Author

we can resolve this by adding a Returns section, which will then pick up on the type annotations:

e.g. for from_dict:

    Returns:
        DataFrame

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation high priority
Projects
None yet
Development

No branches or pull requests

1 participant