pydocstringformatter
pydocstringformatter copied to clipboard
DanielNoord
Automatically format your Python docstrings to conform with PEP 8 and PEP 257
Fixes the first section of: Closes https://github.com/DanielNoord/pydocstringformatter/issues/160
Follow up to https://github.com/DanielNoord/pydocstringformatter/pull/248. I think the idea of that PR should still be pursued and I don't want to lose the branch. I haven't figured out a good way...
I ran `pydocstringformatter --max-line-length=10 -w example.py` on the command line, expecting pydocstringformatter will change this: ``` """Hello yeeeeeeeee.""" ``` to this: ``` """Hello yeee eeeeee.""" ``` But I didn't see...
In the following example pydocstringformatter add a ``.\n`` after "that". ```python def _looks_like_subscriptable(node: ClassDef) -> bool: """ Returns True if the node corresponds to a ClassDef of the Collections.abc module...
```python class A: attribute = 1 """ :type: Optional[int] """ ``` This shouldn't get a period at the end of the line and probably also shouldn't be moved onto one...
I think it would be great to have better docs in a couple of instances. 1. Examples of the supported documentation styles 2. Examples of the changes implied by the...
Hi again ... So I wanted to pitch improving the example/doctest (https://docs.python.org/3/library/doctest.html) support in the library. Right now the behavior is pretty ... not great. This .... ```python def my_function(lst):...
When I was working on my PR, I noticed that tests run directly on the data directories within the tests directory (Im sorry for the complicated sentence). Or the file...
Would it be possible to add support for docstring styles? e.g. Numpy, Google, and rst?
I don't think we fully support these as of now. This is definitely something to look into.
Metadata
Owner
Metadata
Automatically format your Python docstrings to conform with PEP 8 and PEP 257