From e55bee2c09f9081c23014dc3bd1197a391d8bc65 Mon Sep 17 00:00:00 2001 From: Eric Traut Date: Sat, 11 May 2019 19:53:25 -0700 Subject: [PATCH] Updated getting-started instructions. --- docs/getting-started.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/getting-started.md b/docs/getting-started.md index 4dd0e075e..4a1113578 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -10,3 +10,5 @@ Here is a typical progression: 5. Check in your custom type stub files and configure pyright to run as part of your continuous integration (CI) environment to keep the project “type clean”. 6. Incrementally add type annotations to your code files. The annotations that provide most value are on function input parameters, instance variables, and return parameters (in that order). Note that annotation of variables (instance, class and local) requires Python 3.6 or newer. 7. Enable stricter type checking options like "reportOptionalSubscript", "reportOptionalMemberAccess", "reportOptionalCall", and "reportUntypedFunctionDecorator". +8. On a file-by-file basis, enable all type checking options by adding the comment `“# pyright: strict` somewhere in the file. +