From c0f3e5e6e0c46178dc334b29be12e322ac3ca5d6 Mon Sep 17 00:00:00 2001 From: jorenham Date: Sun, 22 Dec 2024 06:50:51 +0100 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20better=20describe=20the=20suppor?= =?UTF-8?q?ted=20numpy=20versions?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 83ee8757..7163cc60 100644 --- a/README.md +++ b/README.md @@ -160,8 +160,8 @@ The versioning scheme of `scipy-stubs` includes the compatible `scipy` version a Even though `scipy-stubs` doesn't enforce an upper bound on the `scipy` version, later `scipy` versions aren't guaranteed to be fully compatible. -The supported range of `numpy` versions are specified in [`SPEC 0`](https://scientific-python.org/specs/spec-0000/), which -`scipy-stubs` aims to follow as close as feasible. +There are no additional restrictions enforced by `scipy-stubs` on the `numpy` requirements. +For `scipy[-stubs]` `1.14.*` and `1.15.*` that is `numpy >= 1.23.5`. Currently, `scipy-stubs` has one required dependency: [`optype`](https://github.com/jorenham/optype). This is essential for `scipy-stubs` to work properly, as it relies heavily on it for annotating (shaped) array-likes, @@ -175,7 +175,8 @@ The exact version requirements are specified in the [`pyproject.toml`](pyproject 1. [`basedpyright`](https://github.com/DetachHead/basedpyright) (recommended) 1. [`basedmypy`](https://github.com/KotlinIsland/basedmypy) 1. [`pyright`](https://pyright.readthedocs.io/en/latest/index.html) -1. [`mypy`](https://mypy.readthedocs.io/en/stable/index.html) (not recommended, see [erictraut/mypy_issues](https://github.com/erictraut/mypy_issues)) +1. [`mypy`](https://mypy.readthedocs.io/en/stable/index.html) (not recommended, see + [mypy_issues](https://github.com/erictraut/mypy_issues)) For validation and testing, `scipy-stubs` primarily uses [`basedmypy`](https://github.com/KotlinIsland/basedmypy) (a `mypy` fork) and [`basedpyright`](https://github.com/DetachHead/basedpyright) (a `pyright` fork).