spadarian / docblock-python

Atom plugin to insert documentation blocks for python functions
GNU General Public License v2.0
22 stars 9 forks source link

Support for python type hinting #7

Closed SKalt closed 6 years ago

SKalt commented 6 years ago

Python3.6.5+ now supports type hinting: https://docs.python.org/3/library/typing.html. Autogenerated docstrings should include the available information about argument and return types. This means documenting

def greeting(name: str) -> str:
    return 'Hello ' + name

should populate something like name (str): [description] ... returns: (str)[description]