heavenshell / vim-pydocstring

Generate Python docstring to your Python source code.
BSD 3-Clause "New" or "Revised" License
337 stars 53 forks source link

[Feature Request] Add support for type hint syntax #13

Closed letientai299 closed 7 years ago

letientai299 commented 7 years ago

Please add support for Type Hint (PEP 484) in Python 3.

As of now, pydocstring create the following result.

def foo(n: int ) -> bool:
    """foo

    :param n:int)->bool::
    """
    return True

It would be much better if we could get following result:


def foo(n: int ) -> bool:
    """foo

    :param n (int):

    :return (bool):
    """
    return True
"""
heavenshell commented 7 years ago

@letientai299 Yeah, I will support it. But this is no easy, so stay tuned.

If you don't wait my implementation, patches are welcome 😊

heavenshell commented 7 years ago

Done #15