@@ -89,32 +89,32 @@ conda install conda-forge::scipy-typed
89
89
### Q: Do I need to change my existing code?
90
90
91
91
** A:** No! ` scipy-stubs ` works with your existing code without any modifications.
92
- Just install it and your type checker and IDE will automatically use the type information.
92
+ Just install it and your type checker and IDE will automatically use the type information.
93
93
94
94
### Q: Will this slow down my code?
95
95
96
96
** A:** Not at all. Type stubs are only used during development and type checking.
97
- They have zero runtime overhead since they're not imported when your code runs.
97
+ They have zero runtime overhead since they're not imported when your code runs.
98
98
99
99
### Q: What if I don't use type hints in my code?
100
100
101
101
** A:** You'll still benefit! Your IDE will provide better autocompletion and error detection
102
- even without explicit type annotations in your code.
102
+ even without explicit type annotations in your code.
103
103
104
104
### Q: Can I use this with Jupyter notebooks?
105
105
106
106
** A:** Yes! Most modern Jupyter environments (JupyterLab, VS Code notebooks) support
107
- type checking and will benefit from ` scipy-stubs ` .
107
+ type checking and will benefit from ` scipy-stubs ` .
108
108
109
109
### Q: What's the difference between this and the built-in scipy typing?
110
110
111
111
** A:** SciPy itself has limited type annotations. ` scipy-stubs ` provides comprehensive,
112
- precise type information for the entire SciPy API, including shape-typing and advanced type features.
112
+ precise type information for the entire SciPy API, including shape-typing and advanced type features.
113
113
114
114
### Q: How do I know if it's working?
115
115
116
116
** A:** You should see improved autocompletion in your IDE and more precise type information.
117
- You can also run ` pyright ` or another type checker on your code to see type checking in action.
117
+ You can also run ` pyright ` or another type checker on your code to see type checking in action.
118
118
119
119
### Q: How much of SciPy is covered?
120
120
@@ -123,8 +123,8 @@ conda install conda-forge::scipy-typed
123
123
### Q: What static type-checkers are supported?
124
124
125
125
** A:** ` scipy-stubs ` is compatible with [ ` pyright ` ] ( https://pyright.readthedocs.io/en/latest/index.html ) (a.k.a. pylance),
126
- [ ` basedpyright ` ] ( https://github.com/DetachHead/basedpyright ) , and [ ` mypy ` ] ( https://github.com/python/mypy ) .
127
- We only support the latest versions of these type-checkers, so make sure to keep them up to date.
126
+ [ ` basedpyright ` ] ( https://github.com/DetachHead/basedpyright ) , and [ ` mypy ` ] ( https://github.com/python/mypy ) .
127
+ We only support the latest versions of these type-checkers, so make sure to keep them up to date.
128
128
129
129
## Versioning and requirements
130
130
0 commit comments