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

Stubtest docs: common failure/suppression examples + debugging guidance #12962

Open
yangdanny97 opened this issue Nov 6, 2024 · 0 comments
Open
Labels
project: infrastructure typeshed build, test, documentation, or distribution related

Comments

@yangdanny97
Copy link
Contributor

I feel like the contributing guide could benefit from instructions around debugging stubtest failures, and examples of things that stubtest can't handle that would warrant suppressions.

The mypy stubtest docs don't really go into enough detail or have enough examples, which makes it harder for new contributors (like myself) to debug failures.

Maybe we could improve that doc and link to it from CONTRIBUTING.md. I think that would reduce the need for maintainers to help stub contributors debug these failures, and make things a bit more self-service.

I'm happy to contribute to this, though I'm a bit too new to know which specific patterns are commonly suppressed.

@yangdanny97 yangdanny97 changed the title Common failure/suppression examples + debugging guidance for stubtest Stubtest docs: common failure/suppression examples + debugging guidance Nov 6, 2024
@Avasam Avasam added the project: infrastructure typeshed build, test, documentation, or distribution related label Nov 25, 2024
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

No branches or pull requests

2 participants