Commit Graph

29 Commits

Author SHA1 Message Date
Eric Traut
501681295b
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)
Co-authored-by: Eric Traut <erictr@microsoft.com>
2023-07-29 22:45:10 -06:00
Eric Traut
08b2cb4698 Did a consistency pass on documentation markdown. 2023-03-06 18:10:33 -07:00
Steve C
fa75fd6556
Fix typo in -> is, in typed-libraries.md (#4180) 2022-11-10 17:51:04 -08:00
Eric Traut
d5d27505ef Updated types in documentation to use PEP 604 syntax. 2022-10-24 20:06:21 -07:00
Eric Traut
04945a4309 Made tweak to documentation for clarity. 2022-06-23 08:34:18 -07:00
Eric Traut
42ad212d8d Added missing quotes in library documentation for __all__ statements. 2022-05-19 17:12:04 -07:00
Eric Traut
2c7bcc81e1 Updated library guidance to include a small section on positional-only parameters. 2022-04-15 21:42:42 -07:00
Eric Traut
77dc80f48a Clarified the role of __all__ in the libraries documentation. 2022-03-11 18:11:55 -07:00
Eric Traut
faecce31ad Updated library guidance to clarify that submodules under a private module are also considered private. 2022-03-04 17:52:51 -07:00
Eric Traut
c9b9676e21 Updated package type verifier to differentiate between "unknown" and "ambiguous" types. 2022-02-24 15:12:36 -07:00
Eric Traut
92b4028cd5 Changed the behavior of the package type verifier so it does not flag unannotated class or instance variables if a parent class provides a type annotation for a variable of the same name. The type is inherited in this case. Also updated the library guidance to reflect this change. 2022-02-11 10:25:48 -08:00
Eric Traut
7e59a19eaa Updated library guidance doc to clarify point of confusion about import forms. 2021-12-01 08:57:29 -08:00
Eric Traut
dbe41fa4d2 Made a few small improvements to the documentation. 2021-09-26 12:10:05 -07:00
Eric Traut
2202af33a7 Improved readability of docs. 2021-08-30 09:44:14 -07:00
Eric Traut
c23d563a17 Took another swing at making the markdown processor in github do what I want in the typed-libraries documentation. 2021-06-22 10:01:50 -07:00
Eric Traut
bf66ff22c5 Fixed a few typos and formatting issues in typed-libraries documentation. 2021-06-22 10:00:30 -07:00
Eric Traut
a192486099 Renamed "--ignore-external" to "--ignoreexternal" for consistency. Removed undocuemented "!" mechanism for invoking this functionality. 2021-03-03 00:51:18 -07:00
Eric Traut
36d499cada Further clarified in the typed libraries docs that “from .A import X” form is honored only in “__init__.py”. 2021-02-23 01:10:51 -07:00
Eric Traut
b5017de462 Updated typed library documentation to explicitly mention import statements of the form “from . import A” and “from .A import X”. 2021-02-23 01:02:15 -07:00
Eric Traut
77410d86e5 Updated typing guidance for libraries documentation based on @JelleZijlstra's feedback. 2021-02-02 20:54:00 -08:00
Simon Hawkins
0977764a7e
Update typed-libraries.md (#1369)
Fixed minor typos in documentation.
2021-01-13 16:55:27 -08:00
Eric Traut
3dc83c0b1a Fixed minor typos in documentation. 2021-01-06 07:38:29 -08:00
Eric Traut
5e5e55449e Changed re-export logic for type stub and py.typed modules to honor the clarification that was recently added to PEP 484. Previously, any import that used an "as" clause was considered to be re-exported. Now, symbols are re-exported only if the "as" clause is redundant (i.e. it is of the form import A as A or from A import X as X). 2020-11-01 08:54:09 -08:00
Eric Traut
246ff993e7 Fixed bug in decorator annotation documentation. 2020-10-14 20:14:08 -07:00
Eric Traut
57175e8d3a Did another editing pass on the typed library documentation for readability and consistency. 2020-10-02 23:56:37 -07:00
Eric Traut
b2882fd6be Added support for the __all__ += <module>.__all__ idiom for mutating the __all__ value. This idiom is used by numpy. 2020-10-02 10:55:24 -07:00
Eric Traut
05cdaf9344 Added missing section on type aliases within typed library documentation. 2020-09-29 15:16:48 -07:00
Eric Traut
67e94f4c8a Fixed markdown rendering issue in docs. 2020-09-29 15:04:51 -07:00
Eric Traut
1cb2a3a950 Added detailed documentation for the "--verifytypes" option. 2020-09-29 15:03:14 -07:00