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

Third-party removal policy if upstream types are unsufficient #11955

Open
srittau opened this issue May 18, 2024 · 1 comment
Open

Third-party removal policy if upstream types are unsufficient #11955

srittau opened this issue May 18, 2024 · 1 comment
Labels
project: policy Organization of the typeshed project

Comments

@srittau
Copy link
Collaborator

srittau commented May 18, 2024

Currently our policy says:

Third-party stubs are generally removed from typeshed when one of the following criteria is met:

  • The upstream package ships a py.typed file for at least six months, or
    [...]

We've had a few cases recently, where upstream added a py.typed file, but the annotations were clearly sub-par compared to the stubs from typeshed. In an ideal world, we'd contribute back our annotations, but that usually requires quite a bit of effort – even compared with continuing to support the stubs in typeshed. (Even if improving upstream's annotations and removal from typeshed should of course be the ultimate goal.)

I suggest to amend our policy to say:

  • The upstream package ships a py.typed file for at least six months, and the upstream type annotations are of a comparable standard to those in typeshed, [...]

The wording still leaves some wiggle room, and isn't overly specific, but is more specific than "usually" for this case.

@srittau srittau added the project: policy Organization of the typeshed project label May 18, 2024
@srittau
Copy link
Collaborator Author

srittau commented May 18, 2024

And we should probably not mark those stubs as "obsolete_since".

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
project: policy Organization of the typeshed project
Projects
None yet
Development

No branches or pull requests

1 participant