VimPlug/typeshed
1
0
Fork 0
mirror of https://github.com/davidhalter/typeshed.git synced 2025-12-08 13:04:46 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Document to stubtest_requirements field in the proper place. (#12707)

Browse Source
This commit is contained in:
Sebastian Rittau
2024-09-30 13:46:48 +02:00
committed by GitHub
parent db265afec5
commit 7ce17a95f6
2 changed files with 6 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
CONTRIBUTING.md
View File

@@ -205,6 +205,9 @@ This has the following keys:
`--ignore_missing_stub` option to the stubtest call. See
[tests/README.md](./tests/README.md) for more information. In most cases,
this field should be identical to `partial_stub`.
* `stubtest_requirements` (default: `[]`): A list of Python packages that need
to be installed for stubtest to run successfully. These packages are installed
in addition to the requirements in the `requires` field.
* `apt_dependencies` (default: `[]`): A list of Ubuntu APT packages
that need to be installed for stubtest to run successfully.
* `brew_dependencies` (default: `[]`): A list of MacOS Homebrew packages

6
tests/README.md
View File

@@ -175,9 +175,9 @@ directly, with
For each distribution, stubtest ignores definitions listed in a `@tests/stubtest_allowlist.txt` file,
relative to the distribution. Platform specific items can be ignored by listing them
in a `@tests/stubtest_allowlist_{platform}.txt` file. Additional packages that are needed
to run stubtest for a
distribution can be added to `tool.stubtest.stubtest_requirements` in `METADATA.toml`.
in a `@tests/stubtest_allowlist_{platform}.txt` file. Additional configuration
can be found in the `tool.stubtest` section of the `METADATA.toml` file. See
[CONTRIBUTING.md](../CONTRIBUTING.md#the-metadatatoml-file) for more information.
### Using stubtest to find objects missing from the stubs