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 comments documentation to talk about reportTypeCommentUsage diagnostic check.

Browse Source
This commit is contained in:
Eric Traut 2022-06-12 11:50:47 -07:00
parent 4e22927305
commit 055dc1296a
1 changed files with 2 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/comments.md
View File

@ -11,6 +11,8 @@ offsets = [] # type: List[int]
self._target = 3 # type: Union[int, str]
```
Future versions of Python will likely deprecate support for type annotation comments. The “reportTypeCommentUsage” diagnostic will report usage of such comments so they can be replaced with inline type annotations.
## File-level Type Controls
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.