Skip to content

Commit 65c154f

Browse files
Document ignore_missing_stub in CONTRIBUTING.md (#11426)
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
1 parent 504cbd4 commit 65c154f

File tree

2 files changed

+5
-2
lines changed

2 files changed

+5
-2
lines changed

CONTRIBUTING.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -202,13 +202,16 @@ supported:
202202
* `partial_stub` (optional): This field marks the type stub package as
203203
[partial](https://peps.python.org/pep-0561/#partial-stub-packages). This is for
204204
3rd-party stubs that don't cover the entirety of the package's public API.
205-
In most cases, this field is identical to `ignore_missing_stub`.
206205

207206
In addition, we specify configuration for stubtest in the `tool.stubtest` table.
208207
This has the following keys:
209208
* `skip` (default: `false`): Whether stubtest should be run against this
210209
package. Please avoid setting this to `true`, and add a comment if you have
211210
to.
211+
* `ignore_missing_stub`: When set to `true`, this will add the
212+
`--ignore_missing_stub` option to the stubtest call. See
213+
[tests/README.md](./tests/README.md) for more information. In most cases,
214+
this field should be identical to `partial_stub`.
212215
* `apt_dependencies` (default: `[]`): A list of Ubuntu APT packages
213216
that need to be installed for stubtest to run successfully.
214217
* `brew_dependencies` (default: `[]`): A list of MacOS Homebrew packages

tests/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,7 @@ but missing from the stub. However, this behaviour can be disabled using the
186186

187187
If a distribution has `ignore_missing_stub = true` in the `[tool.stubtest]` section of its
188188
`tests/METADATA.toml` file, `stubtest_third_party.py` will test that distribution with the
189-
`--ignore-missing-stub option`. This indicates that the stubs for this distribution are
189+
`--ignore-missing-stub` option. This indicates that the stubs for this distribution are
190190
considered "incomplete".
191191

192192
You can help make typeshed's stubs more complete by removing

0 commit comments

Comments
 (0)