From 9ffa1d823722e659ba1ab1d6bb3193aa926aed05 Mon Sep 17 00:00:00 2001 From: Ivan Levkivskyi Date: Sun, 3 Feb 2019 14:47:34 +0000 Subject: [PATCH] Update stubgen link and add a bit more info (#2779) --- CONTRIBUTING.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 46d5342c5..b705bd5e3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -179,11 +179,12 @@ def bar(x: str, y, *, z=...): ... ### Using stubgen -Mypy includes a tool called [stubgen](https://github.com/python/mypy/blob/master/mypy/stubgen.py) -that you can use as a starting point for your stubs. Note that this -generator is currently unable to determine most argument and return -types and omits them or uses ``Any`` in their place. Fill out the types -that you know. +Mypy includes a tool called [stubgen](https://mypy.readthedocs.io/en/latest/stubgen.html) +that auto-generates stubs for Python and C modules using static analysis, +Sphinx docs, and runtime introspection. It can be used to get a starting +point for your stubs. Note that this generator is currently unable to +determine most argument and return types and omits them or uses ``Any`` in +their place. Fill out manually the types that you know. ### Stub file coding style