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

Maintenance updates: docformatter fixes, and mypy/docs updates #53

Merged
merged 5 commits into from
Dec 29, 2023
Merged

Maintenance updates: docformatter fixes, and mypy/docs updates #53

merged 5 commits into from
Dec 29, 2023

Commits on Dec 29, 2023

  1. Fix the docformatter predefined step to handle non-0 exit codes 

    PyCQA/docformatter#137 changed how
docformatter behaves to return 3 when files were modified, so we need to
be able to tell that this is an allowed return code in some cases.
    @BenjaminSchubert
    BenjaminSchubert committed Dec 29, 2023
    Configuration menu
    Copy the full SHA
    7869a70 View commit details
    Browse the repository at this point in the history

  2. Fix docs format to abide to newer docformatter 

    Also pin docformatter to <1.7.1, as it starts misbehaving with :param
entries
    @BenjaminSchubert
    BenjaminSchubert committed Dec 29, 2023
    Configuration menu
    Copy the full SHA
    89f0b1f View commit details
    Browse the repository at this point in the history

  3. Remove now-unneeded ignore types for mypy

    @BenjaminSchubert
    BenjaminSchubert committed Dec 29, 2023
    Configuration menu
    Copy the full SHA
    e6c5f48 View commit details
    Browse the repository at this point in the history

  4. docs: fix broken links in documentation

    @BenjaminSchubert
    BenjaminSchubert committed Dec 29, 2023
    Configuration menu
    Copy the full SHA
    caf3b30 View commit details
    Browse the repository at this point in the history

  5. ci: Limit runtime to 15 minutes and run only one pypy test at a time 

    Otherwise, when tests hang, they take 6 hours to finish. Our mean time
is 8 minutes, thus 15 should be plenty of headroom

The pypy tests seem to hang on GitHub Actions and we dont' get logs for
what happened. Running them serially seems to gix the problem, let's do
that for now
    @BenjaminSchubert
    BenjaminSchubert committed Dec 29, 2023
    Configuration menu
    Copy the full SHA
    7eb6df7 View commit details
    Browse the repository at this point in the history