Skip to content

Commit 35cb22d

Browse files
committed
📝 mention in the FAQ that we test against pyrefly (and some other FAQ cleanup)
1 parent e4f9b72 commit 35cb22d

File tree

1 file changed

+17
-23
lines changed

1 file changed

+17
-23
lines changed

README.md

Lines changed: 17 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -93,45 +93,39 @@ conda install conda-forge::scipy-typed
9393

9494
## Frequently Asked Questions
9595

96+
### Q: What static type-checkers are supported?
97+
98+
**A:** `scipy-stubs` is tested against the most recent stable versions of
99+
100+
- [Mypy](https://github.com/python/mypy),
101+
- [Pyright](https://github.com/microsoft/pyright) (a.k.a. Pylance),
102+
- [BasedPyright](https://github.com/detachhead/basedpyright), and
103+
- [Pyrefly](https://github.com/facebook/pyrefly) (currently in alpha, so it may not always work as expected).
104+
96105
### Q: Do I need to change my existing code?
97106

98107
**A:** No! `scipy-stubs` works with your existing code without any modifications.
99108
Just install it and your type checker and IDE will automatically use the type information.
100109

101-
### Q: Will this slow down my code?
102-
103-
**A:** Not at all. Type stubs are only used during development and type checking.
104-
They have zero runtime overhead since they're not imported when your code runs.
105-
106-
### Q: What if I don't use type hints in my code?
110+
### Q: How much of SciPy is covered?
107111

108-
**A:** You'll still benefit! Your IDE will provide better autocompletion and error detection
109-
even without explicit type annotations in your code.
112+
**A:** All of it! If you find any missing or incorrect type annotations, please open an issue on
113+
[GitHub](https://github.com/scipy/scipy-stubs/issues).
110114

111115
### Q: Can I use this with Jupyter notebooks?
112116

113-
**A:** Yes! Most modern Jupyter environments (JupyterLab, VS Code notebooks) support
117+
**A:** Yes! Most modern Jupyter environments (JupyterLab, VSCode notebooks) support
114118
type checking and will benefit from `scipy-stubs`.
115119

116-
### Q: What's the difference between this and the built-in scipy typing?
120+
### Q: What if I don't use type hints in my code?
117121

118-
**A:** SciPy itself has limited type annotations. `scipy-stubs` provides comprehensive,
119-
precise type information for the entire SciPy API, including shape-typing and advanced type features.
122+
**A:** You'll still benefit! Your IDE will provide better autocompletion and error detection
123+
even without explicit type annotations in your code.
120124

121125
### Q: How do I know if it's working?
122126

123127
**A:** You should see improved autocompletion in your IDE and more precise type information.
124-
You can also run `pyright` or another type checker on your code to see type checking in action.
125-
126-
### Q: How much of SciPy is covered?
127-
128-
**A:** All of it! If you find any missing or incorrect type annotations, please open an issue on [GitHub](https://github.com/scipy/scipy-stubs/issues).
129-
130-
### Q: What static type-checkers are supported?
131-
132-
**A:** `scipy-stubs` is compatible with [`pyright`](https://pyright.readthedocs.io/en/latest/index.html) (a.k.a. pylance),
133-
[`basedpyright`](https://github.com/DetachHead/basedpyright), and [`mypy`](https://github.com/python/mypy).
134-
We only support the latest versions of these type-checkers, so make sure to keep them up to date.
128+
You can also run `mypy`, `pyright` or another type checker on your code to see type checking in action.
135129

136130
## Versioning and requirements
137131

0 commit comments

Comments
 (0)