VimPlug/typeshed
1
0
Fork 0
mirror of https://github.com/davidhalter/typeshed.git synced 2026-02-19 08:14:13 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Support "stub_distribution" and "upload" metadata fields (#9256)

Browse Source
This commit is contained in:
Sebastian Rittau
2022-11-23 13:05:13 +01:00
committed by GitHub
parent bd75ceb0b6
commit 02942b710c
2 changed files with 24 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
CONTRIBUTING.md
View File

@@ -176,6 +176,9 @@ supported:
* `extra_description` (optional): Can be used to add a custom description to
the package's long description. It should be a multi-line string in
Markdown format.
* `stub_distribution` (optional): Distribution name to be uploaded to PyPI.
This defaults to `types-<distribution>` and should only be set in special
cases.
* `obsolete_since` (optional): This field is part of our process for
[removing obsolete third-party libraries](#third-party-library-removal-policy).
It contains the first version of the corresponding library that ships
@@ -183,6 +186,9 @@ supported:
* `no_longer_updated` (optional): This field is set to `true` before removing
stubs for other reasons than the upstream library shipping with type
information.
* `upload` (optional): This field is set to `false` to prevent automatic
uploads to PyPI. This should only used in special cases, e.g. when the stubs
break the upload.
In addition, we specify configuration for stubtest in the `tool.stubtest` table.
This has the following keys: