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

[Proposal] Add some PEP 484 type checking via pytype #187

Closed
wants to merge 4 commits into from
Closed

[Proposal] Add some PEP 484 type checking via pytype #187

wants to merge 4 commits into from

Commits on Apr 13, 2021

  1. Create pytype section in config, fix initial false-positives

    @vrusinov
    vrusinov committed Apr 13, 2021
    Configuration menu
    Copy the full SHA
    dedb810 View commit details
    Browse the repository at this point in the history

  2. Add type annotations to public functions of __init__

    @vrusinov
    vrusinov committed Apr 13, 2021
    Configuration menu
    Copy the full SHA
    5664ed4 View commit details
    Browse the repository at this point in the history

  3. Enable autodoc-typehints Sphinx plugin 

    With it the docimentation can refer to type annotations. See 
https://github.com/agronholm/sphinx-autodoc-typehints
    @vrusinov
    vrusinov committed Apr 13, 2021
    Configuration menu
    Copy the full SHA
    f8d28c5 View commit details
    Browse the repository at this point in the history

  4. Replace Sphinx type annotations with PEP 484 annotations in the context 

    module.

Note thanks to sphinx-autodoc-typehints added in previous commit this
should not reduce the quality of the generated documentation.
    @vrusinov
    vrusinov committed Apr 13, 2021
    Configuration menu
    Copy the full SHA
    06825a8 View commit details
    Browse the repository at this point in the history