From 7ce17a95f6dca0192e35ad5524775e84622c1206 Mon Sep 17 00:00:00 2001 From: Sebastian Rittau Date: Mon, 30 Sep 2024 13:46:48 +0200 Subject: [PATCH] Document to stubtest_requirements field in the proper place. (#12707) --- CONTRIBUTING.md | 3 +++ tests/README.md | 6 +++--- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7a468cdca..e1830ac06 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 diff --git a/tests/README.md b/tests/README.md index 074a7b6ef..aff1016c0 100644 --- a/tests/README.md +++ b/tests/README.md @@ -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