VimPlug/typeshed
1
0
Fork 0
mirror of https://github.com/davidhalter/typeshed.git synced 2026-07-23 00:20:31 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Use dashes instead of underscores for METADATA.toml field names (#15614)

Browse Source
This commit is contained in:
lev-blit
2026-04-07 15:03:53 +02:00
committed by GitHub
parent 7eb0dddd46
commit 563213272e
204 changed files with 365 additions and 362 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tests/README.md
+4 -4
View File
@@ -169,13 +169,13 @@ By default, stubtest emits an error if a public object is present at runtime
but missing from the stub. However, this behaviour can be disabled using the
`--ignore-missing-stub` option.
If a distribution has `ignore_missing_stub = true` in the `[tool.stubtest]` section of its
If a distribution has `ignore-missing-stub = true` in the `[tool.stubtest]` section of its
`tests/METADATA.toml` file, `stubtest_third_party.py` will test that distribution with the
`--ignore-missing-stub` option. This indicates that the stubs for this distribution are
considered "incomplete".
You can help make typeshed's stubs more complete by removing
`ignore_missing_stub = true` from the `tests/METADATA.toml` file for a
`ignore-missing-stub = true` from the `tests/METADATA.toml` file for a
third-party stubs distribution, running stubtest, and then adding things that
stubtest reports to be missing to the stub. However, note that not *everything*
that stubtest reports to be missing should necessarily be added to the stub.
@@ -191,8 +191,8 @@ leverage type information provided by these plugins when validating stubs.
To use this feature, add the following configuration to the `tool.stubtest` section in your METADATA.toml:
```toml
mypy_plugins = ["mypy_django_plugin.main"]
mypy_plugins_config = { "django-stubs" = { "django_settings_module" = "@tests.django_settings" } }
mypy-plugins = ["mypy_django_plugin.main"]
mypy-plugins-config = { "django-stubs" = { "django_settings_module" = "@tests.django_settings" } }
```
For Django stubs specifically, you'll need to create a `django_settings.py` file in your `@tests` directory