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.

Sign up for GitHub

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

Jump to bottom

Put rtype before examples or usage section #290

Merged
merged 1 commit into from
Jan 15, 2023
Merged

Put rtype before examples or usage section #290

merged 1 commit into from
Jan 15, 2023

Commits on Jan 15, 2023

  1. Put rtype before examples or usage section 

    Sometimes a function's documentation will contain a section like
'Usage' or 'Examples', warnings about edge cases, etc. These
sections are introduced with a .. directive::. This makes it so
that sphinx-autodoc-typehints inserts the return type ahead of
these sections, rather than after them.
    @hoodmane
    hoodmane committed Jan 15, 2023
    Configuration menu
    Copy the full SHA
    f2964af View commit details
    Browse the repository at this point in the history