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

DOC: Use google style docstrings #1534

Merged
merged 7 commits into from
Jan 7, 2023
Merged

DOC: Use google style docstrings #1534

merged 7 commits into from
Jan 7, 2023

Commits on Jan 6, 2023

  1. DOC: Use google style docstrings 

    The Google Docstring style is way more readable than ReST style docstrings.

Additionally, replace most instances of 'pragma: no-cover' by
'deprecated'.

Tools used:
- pyment
- pydocstyle
    @MartinThoma
    MartinThoma committed Jan 6, 2023
    Configuration menu
    Copy the full SHA
    4d8f506 View commit details
    Browse the repository at this point in the history

Commits on Jan 7, 2023

  1. Merge branch 'main' into google-docs

    @MartinThoma
    MartinThoma authored Jan 7, 2023
    Configuration menu
    Copy the full SHA
    327672d View commit details
    Browse the repository at this point in the history

  2. Shorten: python_use_unqualified_type_names=True

    @MartinThoma
    MartinThoma committed Jan 7, 2023
    Configuration menu
    Copy the full SHA
    6362af0 View commit details
    Browse the repository at this point in the history

  3. Document how to document

    @MartinThoma
    MartinThoma committed Jan 7, 2023
    Configuration menu
    Copy the full SHA
    b9ec308 View commit details
    Browse the repository at this point in the history

  4. Remove property 'returns'

    @MartinThoma
    MartinThoma committed Jan 7, 2023
    Configuration menu
    Copy the full SHA
    55fa0cc View commit details
    Browse the repository at this point in the history

  5. Minor fixes

    @MartinThoma
    MartinThoma committed Jan 7, 2023
    Configuration menu
    Copy the full SHA
    7224b36 View commit details
    Browse the repository at this point in the history

  6. Merge branch 'main' into google-docs

    @MartinThoma
    MartinThoma authored Jan 7, 2023
    Configuration menu
    Copy the full SHA
    70747a6 View commit details
    Browse the repository at this point in the history