Skip to content

Improve README in test_cases directory #8441

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

Closed
AlexWaygood opened this issue Jul 29, 2022 · 0 comments · Fixed by #8445
Closed

Improve README in test_cases directory #8441

AlexWaygood opened this issue Jul 29, 2022 · 0 comments · Fixed by #8445
Assignees
Labels
project: infrastructure typeshed build, test, documentation, or distribution related

Comments

@AlexWaygood
Copy link
Member

This is basically a TODO for me (though if somebody else wants to help out, they're welcome!).

  • Different test cases serve different purposes -- the tests in test_logging and test_object are pretty different to the tests in test_pow. Explain the different purposes of these tests in the README.
  • Document that PEP 585 can't be used in the test_cases directory (unless from __future__ import annotations is at the top of the file). At the moment it says you can't always use new syntax in stubs, but the only examples given are PEP 604-related.
  • Document use of # type: ignore'd lines (in combination with pyright: reportUnnecessaryTypeIgnoreComment=true and mypy's --warn-unused-ignore settings) to check for cases where we want a type checker to report an error. This can maybe just be a link to https://typing.readthedocs.io/en/latest/source/quality.html#testing-using-assert-type-and-warn-unused-ignores
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
project: infrastructure typeshed build, test, documentation, or distribution related
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants