Skip to content

Commit

Permalink
Add section for running basedpyright from cli
Browse files Browse the repository at this point in the history
  • Loading branch information
ItsDrike committed Aug 8, 2024
1 parent 38de4ff commit ed2991f
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions docs/contributing/guides/type-hints.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,19 @@ The type checker that we use in our code-base is [**basedpyright**](https://docs
pyright which adds some extra checks and features and focuses more on the open-source community, than the
official Microsoft owned Pyright.

### Running BasedPyright

To run BasedPyright on the code-base, you can use the following command:

```bash
basedpyright .
```

!!! note ""

You will need to run this from an [activated](./setup.md#activating-the-environment) poetry environment while
in the project's root directory.

### Editor Integration

=== "VSCode"
Expand Down

0 comments on commit ed2991f

Please sign in to comment.