pyment
pyment copied to clipboard
dadadel
Format and convert Python docstrings and generates patches
Example, call this ``test_bullets.py``, ```python """Silly mathematical example.""" import math def euclidean_distance(point_a, point_b): """Return the Euclidean distance between points A and B. Arguments: - point_a - point in space as...
If a function has no argument and a multi-line description, Pyment will insert two blank lines between the description and the end of the docstring. It should be one blank...
If a function a google docstring describing a parameter with a type, instead of letting it as is when producing google output format, Pyment will replace the param description by...
Using the following input, the paragraphs are all placed together with several intervening lines, and the doctests are all placed at the end. ``` python from __future__ import (absolute_import, division,...
I tend to document my class with both a class doc string and a separate `__init__` docstring for the constructor. Pyment seems to treat class doc strings as if they...
As @patkujawa-wf and @maqifrnswa pointed, the two syntaxes `:return:` and `:returns:` are valid for the reStructuredText format, so it would be nice to accept both and choose the default one...
 See picture. Docstrings that start `r"""` instead of `"""` are prepended with an extra tripple quote.
Hi, thanks for creating such a cool tool! I am having an issue with my docstrings where the types are not getting recognized. For example, when I run pyment on...
lineno 97-99 for https://github.com/dadadel/pyment/blob/master/pyment/pyment.py encoding is not defined when opening the file, default encoding on windows is cp1252 and fails when a unicode character is encountered. Suggest adding an argument...
Considering the following demo functions: ```python def a(first: Callable[[Column], Column]) -> Callable[[str], Column]: """ :param first: Callable[[Column]: :param Column]: """ pass def b( colName: str, startPos: Union[int, "Column"], length: Union[int,...
