microsoft/pyright
1
1
Fork 0
mirror of https://github.com/microsoft/pyright.git synced 2024-08-16 11:20:22 +03:00
Code Issues Projects Releases Wiki Activity

Updated documentation to cover the new # pyright: basic comment.

Browse Source
This commit is contained in:
Eric Traut 2022-01-19 12:53:07 -08:00
parent ad823f469f
commit da81cdf22f
1 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/comments.md
View File

@ -12,13 +12,19 @@ self._target = 3 # type: Union[int, str]
```
## File-level Type Controls
Strict typing controls (where all supported type-checking switches generate errors) can be enabled for a file through the use of a special comment. Typically this comment is placed at or near the top of a code file on its own line.
Strict type checking, where most supported type-checking switches generate errors, can be enabled for a file through the use of a special comment. Typically this comment is placed at or near the top of a code file on its own line.
```python
# pyright: strict
```
Individual configuration settings can also be overridden on a per-file basis and combined with “strict” typing. For example, if you want to enable all type checks except for “reportPrivateUsage”, you could add the following comment:
Likewise, basic type checking can be enabled for a file.
```python
# pyright: basic
```
Individual configuration settings can also be overridden on a per-file basis and optionally combined with “strict” or “basic” type checking. For example, if you want to enable all type checks except for “reportPrivateUsage”, you could add the following comment:
```python
# pyright: strict, reportPrivateUsage=false