Generate missing docstrings (numpydoc style) in your Python source code.
Requirements:
Python 3.10+
This program will also parse the Python 3.X.X type hints and add them to the
generated docstring.
For example, when the following file is piped to npdocstring
def test_function(a: int, b: List[int]) -> int:
b.append(a)
return sum(b)npdocstring outputs this
def test_function(a: int, b: List[int]) -> int:
'''
Parameters
----------
a : int
FIXME
b : list of int
FIXME
Returns
-------
int
FIXME
'''
b.append(a)
return sum(b)