Web lists-archives.com

Bug#876813: ITP: pyment -- Create, update or convert docstrings in existing Python files




Package: wnpp
Severity: wishlist
Owner: Mike Gabriel <mike.gabriel@xxxxxxxxxxxxxxxxxxx>

* Package name    : pyment
  Version         : 3.0
  Upstream Author : A. Daouzli (https://github.com/dadadel/)
* URL             : https://github.com/dadadel/pyment/
* License         : GPL-3
  Programming Lang: Python
  Description     : Create, update or convert docstrings in existing Python files

 The pyment program intends to help Python programmers to enhance inside
 code documentation using docstrings. It is useful for code not well
 documented, or code without docstrings, or some not yet or partially
 documented code, or a mix of all of this. It can be helpful also to
 harmonize or change a project's docstring style format.
 .
 It will parse one or several Python scripts and retrieve existing
 docstrings. Then, for all found functions/methods/classes, it will
 generate formated docstrings with parameters, default values, etc.
 .
 At the end, patches are generated for each file. These patches can
 applied to the initial scripts. An option allows one to update the files
 directly without generating patches. It is also possible to generate the
 Python files with the new docstrings, or to only retrieve the
 docstrings.
 .
 Currently, the managed styles in input/output are javadoc, one variant
 of reST (re-Structured Text, used by Sphinx), numpydoc, google
 docstrings, groups (other grouped style).