Add link to sample stub packages (#713)

This commit is contained in:
Ethan Smith 2018-07-09 19:20:35 +01:00 committed by Guido van Rossum
parent 79480d5cde
commit 7d51890d81
1 changed files with 18 additions and 4 deletions

View File

@ -212,13 +212,17 @@ Implementation
The proposed scheme of indicating support for typing is completely backwards
compatible, and requires no modification to package tooling. A sample package
with inline types is available [typed_pkg]_, as well as a sample package
checker [pkg_checker]_ which reads the metadata of installed packages and
reports on their status as either not typed, inline typed, or a stub package.
with inline types is available [typed_package]_, as well as a [stub_package]_. A
sample package checker [pkg_checker]_ which reads the metadata of installed
packages and reports on their status as either not typed, inline typed, or a
stub package.
The mypy type checker has an implementation of PEP 561 searching which can be
read about in the mypy docs [4]_.
[numpy-stubs]_ is an example of a real stub-only package for the numpy
distribution.
Acknowledgements
================
@ -231,6 +235,10 @@ Vlasovskikh, Nathaniel Smith, and Guido van Rossum.
Version History
===============
* 2018-07-09
* Add links to sample stub-only packages
* 2018-06-19
* Partial stub packages can look at typeshed as well as runtime packages
@ -293,9 +301,15 @@ References
.. [4] Example implementation in a type checker
(https://mypy.readthedocs.io/en/latest/installed_packages.html)
.. [typed_pkg] Sample typed package
.. [stub_package] A stub-only package
(https://github.com/ethanhs/stub-package)
.. [typed_package] Sample typed package
(https://github.com/ethanhs/sample-typed-package)
.. [numpy-stubs] Stubs for numpy
(https://github.com/numpy/numpy-stubs)
.. [pkg_checker] Sample package checker
(https://github.com/ethanhs/check_typedpkg)