Generate missing numpydoc docstrings in your Python source code.
Python
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
tests
.gitignore
.style.yapf
.travis.yml
LICENSE.md
README.md
npdocstring.py
requirements.txt
tox.ini

README.md

npdocstring

Generate missing docstrings (numpydoc style) in your Python source code.

Requirements:

  • Python 3.5+

Build Status

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)