Skip to content

Commit

Permalink
Better description for Configuration file
Browse files Browse the repository at this point in the history
  • Loading branch information
InSyncWithFoo committed Mar 1, 2024
1 parent 43d253d commit 2d92682
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 5 deletions.
4 changes: 1 addition & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,7 @@ You should see Pyright annotations in a few seconds.

This is only a minimum viable product.

* Tests have not been written,
and manual tests have only been performed on Windows.
* There are no documentations; the UX might be terrible for some.
* There are no tests. Manual checks are only performed on Windows.
* Since `ExternalAnnotator`s are only called after all other annotators
have run, expect a major delay (up to a few seconds) between checks.

Expand Down
5 changes: 3 additions & 2 deletions docs/configurations.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,16 @@ It would be interpreted as relative to the project directory.

### Configuration file

Despite being called "file", you can specify a path to a directory
Despite being called "file", this can be a path to a directory
containing `pyright-config.json` and/or `pyproject.toml`.
This path will be passed to the executable via [the `-p` option][1].

* If the executable is local, only the local path is used.
* If the executable is global, the local path is used if it is specified,
falling back to the global one.

If neither paths are specified, the project directory is used.
If the path retrieved using the aforementioned strategy is not specified,
the project directory is used.


## Global
Expand Down

0 comments on commit 2d92682

Please sign in to comment.