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

Add docstrings to tests #104

Merged

Conversation

davidorme
Copy link
Collaborator

@davidorme davidorme commented Sep 15, 2023

This PR:

  • Re-enables flake8 testing for the tests directory via setup.cfg.
  • Adds at least minimal docstrings to all of the existing tests, adding more detailed docstrings where needed.
  • Tidies up a few other flake8 issues such as overlong lines.
  • Fixes some minor typing issues within the tests.

The setup.cfg currently turns off some mypy checking in tests through a [mypy-tests.*] section, notably allowing untyped_calls, untyped_defs and incomplete_defs. I have kept this setting - typing all of the test signatures doesn't seem a priority.

Closes #63

@davidorme davidorme linked an issue Sep 15, 2023 that may be closed by this pull request
Copy link
Collaborator

@MarionBWeinzierl MarionBWeinzierl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me

@davidorme davidorme merged commit 389a911 into develop Sep 15, 2023
22 checks passed
@davidorme davidorme deleted the 63-add-docstrings-to-unit-tests-where-these-are-missing branch September 15, 2023 13:33
MarionBWeinzierl pushed a commit that referenced this pull request Oct 16, 2023
…to-unit-tests-where-these-are-missing

Add docstrings to tests
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Add docstrings to unit tests where these are missing.
2 participants