Commit Graph

390 Commits

Author SHA1 Message Date
Eric Traut
ff134e6467 Added documentation to mypy comparison that talks about narrowing for captured variables. 2023-04-02 08:34:28 -07:00
Eric Traut
08085479ef Extended type narrowing for type guards of the form x[I] is B and x[I] is not B where x is a tuple and B is an enum literal. 2023-03-30 18:26:46 -07:00
Eric Traut
f1db88481f Added support for type guards of the form x[I] is B and x[I] is not B where x is a tuple and B is a boolean literal True or False. This addresses part of https://github.com/microsoft/pyright/issues/4875. 2023-03-30 18:10:06 -07:00
Dmitry Volodin
14b0831697
Fix Markdown links (#4849)
* Fixed Markdown links

* Gave main doc page prettier name
2023-03-27 19:48:11 -06:00
Eric Traut
e2e3a5c9ff Added new diagnostic check reportImplicitOverride. This addresses https://github.com/microsoft/pyright/issues/4788. 2023-03-16 09:52:25 -06:00
Eric Traut
65ca325a14 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
Eric Traut
3f987e3137 Fixed broken links in README for npmjs page. Added missing link to command line interface documentation in sidebar. 2023-03-09 09:46:17 -07:00
Eric Traut
9c6ebad347 Updated mypy comparison to reflect change in mypy's type narrowing capabilities. 2023-03-09 08:21:01 -07:00
Eric Traut
c83a95e62e More improvements to documentation. 2023-03-07 16:38:22 -07:00
Eric Traut
414dce170e Updated documentation for import modeling differences between mypy and pyright. 2023-03-07 10:16:14 -07:00
Eric Traut
1fdeadeca6 Improved "getting started" documentation. 2023-03-07 09:53:49 -07:00
Eric Traut
a00a026953 Fixed capitalization inconsistency in docs. 2023-03-06 18:12:20 -07:00
Eric Traut
08b2cb4698 Did a consistency pass on documentation markdown. 2023-03-06 18:10:33 -07:00
Eric Traut
f7db5822ef Ran auto-formatter on html to avoid style issue in CI. 2023-03-06 17:59:23 -07:00
Eric Traut
8f17673300 Fixed main Pyright link in sidebar. 2023-03-06 17:55:58 -07:00
Eric Traut
400dd260cc Another small tweak to docs sidebar. 2023-03-06 17:54:36 -07:00
Eric Traut
2c4a9da2ae More tweaks to documentation and README files. Added a navbar to docs site. 2023-03-06 17:52:06 -07:00
Eric Traut
65874c5254 Small tweak for main docs page. 2023-03-06 17:45:37 -07:00
Eric Traut
deabba5e6a Tweaked documentation theming and added language highlighting for json. 2023-03-06 17:44:15 -07:00
Eric Traut
2827c94d89 Small correction to settings documentation. 2023-03-06 16:10:06 -07:00
Eric Traut
dc87fa46af Added a missing HTML tag to index.html. 2023-03-06 16:03:19 -07:00
Eric Traut
6cb2f4a058 Moved installation instructions and FAQ to their own docs pages, further simplifying the main README. 2023-03-06 15:58:44 -07:00
Eric Traut
b61f121efe Minor tweak to README. 2023-03-06 15:51:49 -07:00
Eric Traut
4c4aec52a5 Added support for docsify-based docs site. 2023-03-06 15:46:07 -07:00
Eric Traut
b3fd962116 Fixed bugs in documentation. 2023-03-06 15:45:51 -07:00
Eric Traut
735c19a1c9 Improved documentation for ... function bodies. 2023-03-06 10:49:54 -07:00
Eric Traut
7197a8d624 Added documentation for import statements. 2023-03-06 08:49:00 -07:00
Eric Traut
81f21ee3d4 Added support for type guard patterns type(x) == T and type(x) != T. This addresses https://github.com/microsoft/pyright/issues/4719. 2023-03-01 23:29:44 -07:00
ErezAmihud
2857963212
add gitlab ci documentation (#4704) 2023-02-27 13:57:05 -07:00
Eric Traut
526d907def Slimmed down the README to remove information that most pyright users probably don't care about. Features of pyright were moved to a separate "features.md" document. 2023-02-26 10:54:20 -07:00
Eric Traut
344b091bfe Minor formatting improvements to documentation. 2023-02-14 18:23:13 -08:00
Eric Traut
4eb4397a90 Updated documentation for default exclude settings. 2023-02-08 13:09:55 -08:00
Eric Traut
f8eb114de3 Fixed a few typos in the pyright documentation. 2023-02-01 08:09:36 -08:00
Eric Traut
b17f64ddcb A few more tweaks to the documentation for consistency. 2023-01-27 09:29:38 -08:00
Eric Traut
3829e8e32d Tweaked documentation for readability. 2023-01-27 09:26:30 -08:00
Eric Traut
53e8cd4145 Added provisional support for draft PEP 702 (marking deprecations using the type system). 2023-01-13 21:16:07 -08:00
Eric Traut
a2784020f2 Added support for x[K] is V and x[K] is not V type narrowing forms. This addresses https://github.com/microsoft/pyright/issues/4453. 2023-01-13 16:53:18 -08:00
Eric Traut
452bd59778 Updated build instructions. 2023-01-08 09:20:12 -08:00
Christian Clauss
bd3ac8b722
Fix typos discovered by codespell (#4399) 2023-01-04 06:54:43 -07:00
Eric Traut
c7626944f1 Added support for type guard forms x is ..., x is not ..., x == ... and x != .... Support for these were recently added to mypy. This addresses https://github.com/microsoft/pyright/issues/4397. 2023-01-04 06:13:44 -07:00
Christian Clauss
7be1d77360
Fix typo (#4398) 2023-01-04 05:53:27 -07:00
Eric Traut
775b7b4d85 Improved handling of TypeVars that appear only within a Callable within a return type annotation for a function. By a strict reading of PEP 484, these should be bound to the function's scope, but practically, they are bound to the Callable. This allows a function to return a generic callable type. When TypeVars are rescoped in this manner, the TypeVar cannot be referenced within the function body because it is no longer in scope in that context. This addresses https://github.com/microsoft/pyright/issues/4285. 2022-12-25 10:57:02 -07:00
Eric Traut
0be873e289 Fixed a couple of typos in the documentation. 2022-12-21 10:47:28 -07:00
Eric Traut
97b6231d13 Added a few more minor improvements to the docs. 2022-12-18 18:40:29 -08:00
Jelle Zijlstra
355361e8b3
fix typos in mypy-comparison (#4354)
* fix typos in mypy-comparison

* fix versions
2022-12-18 18:15:17 -08:00
Eric Traut
e3ddbb3171 Small tweaks to the new documentation based on proofreading pass. 2022-12-18 15:24:59 -08:00
Eric Traut
5a19cb9f0a Added documentation that covers the major behavioral differences between pyright and mypy and the justifications for those differences. 2022-12-18 15:11:11 -08:00
Eric Traut
c4e61dcc6a Fixed a few bugs in the type guard documentation. 2022-12-18 15:10:30 -08:00
Eric Traut
8d3a6e62c8 Further clarified the new overload behavior in the documentation. 2022-12-18 08:06:47 -08:00
Eric Traut
1dc84b93b1 Modified the overload matching algorithm to match the behavior of mypy when the overload match is ambiguous because an argument evaluates to Any or Unknown. In this case, the call expression evaluates to Unknown. Previously, pyright used the first of the matching overloads in this case. This addresses https://github.com/microsoft/pyright/issues/4347. 2022-12-16 23:18:37 -08:00