From f696209d53dea087065a9d7456fbe6bffb87cf79 Mon Sep 17 00:00:00 2001 From: Guido van Rossum Date: Fri, 2 Mar 2018 11:15:12 -0800 Subject: [PATCH] Add guideline for undocumented objects. Also add Ivan as a typeshed core dev (since he is in the group). --- CONTRIBUTING.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cbde40a3fae5..ccefefff7a3f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -82,6 +82,7 @@ At present the core developers are (alphabetically): * David Fisher (@ddfisher) * Łukasz Langa (@ambv) * Jukka Lehtosalo (@JukkaL) +* Ivan Levkivskyi (@ilevkivskyi) * Matthias Kramm (@matthiaskramm) * Greg Price (@gnprice) * Guido van Rossum (@gvanrossum) @@ -133,6 +134,15 @@ included in ``__all__`` (if present), and whose names do not start with an underscore are more likely to merit inclusion in a stub. If in doubt, err on the side of including more objects. +**NEW:** Sometimes it makes sense to include non-public objects +in a stub. Mark these with a comment of the form ``# undocumented``. +See the [motivation](https://github.com/python/typeshed/issues/1902). +Example: + +```python +def list2cmdline(seq: Sequence[str]) -> str: ... # undocumented +``` + ### Using stubgen Mypy includes a tool called [stubgen](https://github.com/python/mypy/blob/master/mypy/stubgen.py)