Skip to content

📝 fix mypy instructions in contributing guide #595

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 31, 2025
Merged

📝 fix mypy instructions in contributing guide #595

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
66d63ec
📝 remove unstub instructions for mypy in contributing guide
Jeitan Jul 30, 2025
81ec304
🔥 remove unstub.py as unnecessary
Jeitan Jul 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 1 addition & 4 deletions docs/dev/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,10 +60,7 @@ See <https://docs.basedpyright.com/> for IDE integration and other info.

### mypy

Mypy is used for type-checking the codebase and the type-tests. It takes more effort to run it on the codebase than `basedpyright`.
This is primarily a consequence of mypy's inconsequent prioritization of the stubs bundled
with NumPy over the `numpy-stubs` within a local development environment.
To get around this, you can delete all `*.pyi` from your **local** `numpy` installation directory by running `uv tool/unstub.py`.
Mypy is used for type-checking the codebase and the type-tests.

**General Type Checking**

Expand Down
8 changes: 0 additions & 8 deletions tool/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,14 +32,6 @@ Test type stubs against actual implementations using MyPy's stubtest.
uv run tool/stubtest.py <OPTIONS>
```

## unstub.py

Remove all `.pyi` files from the NumPy site-packages directory.

```shell
uv run tool/unstub.py
```

## format_ignores.py

Format pyright ignore comments to ensure they are alphabetically sorted with proper spacing.
Expand Down
16 changes: 0 additions & 16 deletions tool/unstub.py
View file
Open in desktop

This file was deleted.

Loading