pyright/docs
charliecloudberry 45159a96da
Some checks failed
Validation / Typecheck (push) Has been cancelled
Validation / Style (push) Has been cancelled
Validation / Test macos-latest (push) Has been cancelled
Validation / Test ubuntu-latest (push) Has been cancelled
Validation / Test windows-latest (push) Has been cancelled
Validation / Build (push) Has been cancelled
Validation / Required (push) Has been cancelled
Update installation.md (#11175)
Remove the hardcoded docs version from PyCharm documentation link
2025-12-17 08:27:28 -08:00
..
img Moved badge to docs/img folder. 2023-05-06 08:25:03 -07:00
.nojekyll Added support for docsify-based docs site. 2023-03-06 15:46:07 -07:00
_navbar.md docs: fix "GitHub" typesetting (#10040) 2025-03-06 01:46:10 -07:00
_sidebar.md Fixed bad link in documentation. 2024-03-26 14:06:02 -06:00
build-debug.md Debugging (#7332) 2024-02-25 15:26:06 -07:00
builtins.md Did a consistency pass on documentation markdown. 2023-03-06 18:10:33 -07:00
ci-integration.md Drop support for node 12 (#7375) 2024-02-29 10:47:42 -07:00
command-line.md Added support for multithreaded type checking in CLI. (#8309) 2024-07-04 20:52:37 -07:00
commands.md Did a consistency pass on documentation markdown. 2023-03-06 18:10:33 -07:00
comments.md Changed # pyright: basic file-level comment so it overrides "strict" settings specified in the config file or language server settings. This allows an individual file to be "downgraded" from strict to basic. This addresses https://github.com/microsoft/pyright/issues/4751. 2023-03-09 10:28:44 -07:00
configuration.md Removed "reportShadowedImports" check and associated "renameShadowedFile" action. This feature is off by default in pyright although enabled by default in pylance. (#10891) 2025-09-08 09:35:09 -07:00
features.md Made PEP 728 (TypedDict with extra items) no longer experimental since it has been accepted by the SC. (#10804) 2025-08-15 08:41:24 -07:00
getting-started.md Changed the default of the useLibraryCodeForTypes from false to true to bring pylance and pyright into alignment. Also deprecated the "--lib" command-line option, which was previously used to enable useLibraryCodeForTypes from the command line. (#4903) 2023-04-05 09:47:59 -06:00
import-resolution.md Clarify editable install behavior with setuptools and uv (#10888) 2025-09-04 00:13:18 -07:00
import-statements.md Clarified implicit import rules in docs. 2025-09-19 09:10:28 -07:00
index.html Fix Markdown links (#4849) 2023-03-27 19:48:11 -06:00
installation.md Update installation.md (#11175) 2025-12-17 08:27:28 -08:00
internals.md Deleted redundant documentation. 2023-06-05 15:06:24 -06:00
mypy-comparison.md Fixed minor grammar error in documentation. 2025-02-27 18:48:03 -07:00
README.md Pull Pylance with Pyright 1.1.400 (#10398) 2025-04-30 19:17:26 -07:00
settings.md Changed disableLanguageServices feature to apply to hover text as well as other language services. Previously, hover text was excluded. This addresses #8639. 2024-08-02 07:59:47 -06:00
type-concepts-advanced.md Added reportUnreachable diagnostic check. If enabled, it emits a diagnostic for code that is determined to be structurally unreachable or unreachable via type analysis. It does not report code that is within a code block that is gated by a conditional that is statically determined to be false, such as TYPE_CHECKING and version checks. This diagnostic check is off by default even in strict mode because there are legitimate reasons for unreachable code to exist in Python code. (#10581) 2025-06-09 22:07:56 -07:00
type-concepts.md Added a few useful links to the docs. 2024-01-21 20:35:11 -08:00
type-inference.md Fix a small typo in Understanding Type Inference (#8877) 2024-09-02 08:50:11 -07:00
type-stubs.md Fix typo in type-stubs.md (#8037) 2024-05-31 20:00:30 -07:00
typed-libraries.md Modified type inference logic so methods that raise an exception whose type derives from NotImplementedError is not inferred to return NoReturn. Previously, only NotImplementedError was exempted, not subclasses. This addresses https://github.com/microsoft/pyright/issues/5608. (#5609) 2023-07-29 22:45:10 -06:00

Pyright

Static type checker for Python

Pyright is a full-featured, standards-compliant static type checker for Python. It is designed for high performance and can be used with large Python source bases.

Pyright includes a command-line tool, a language server, and an extension for Visual Studio Code.