Skip to content

Commit ed2991f

Browse files
committed
Add section for running basedpyright from cli
1 parent 38de4ff commit ed2991f

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

docs/contributing/guides/type-hints.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,19 @@ The type checker that we use in our code-base is [**basedpyright**](https://docs
9090
pyright which adds some extra checks and features and focuses more on the open-source community, than the
9191
official Microsoft owned Pyright.
9292

93+
### Running BasedPyright
94+
95+
To run BasedPyright on the code-base, you can use the following command:
96+
97+
```bash
98+
basedpyright .
99+
```
100+
101+
!!! note ""
102+
103+
You will need to run this from an [activated](./setup.md#activating-the-environment) poetry environment while
104+
in the project's root directory.
105+
93106
### Editor Integration
94107

95108
=== "VSCode"

0 commit comments

Comments
 (0)