google / google/yapf

Reformatting docstrings and comments

Open
#279 7 comments 46 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
14k
Forks
904
PR merge metrics
No merged PRs in 30d

Description

By running the current 0.10.0 version of yapf on

``` Py
def func(a):
"""Do something awesome.

This is a long long long description of the awesome work that is done by this function. Despite being very detailed, it runs over the column limit.
"""
```

we basically cannot get any formatting of the docstring. Could you please help me if it is a feature that is currently absent from yapf? If it could be reformatted into something like,

``` Py
def func(a):
"""Do something awesome.

This is a long long long description of the awesome work that is done by
this function. Despite being very detailed, it runs over the column limit.
"""
```

quite a lot of something like `gq` in vim could be saved. If it could reformat the docstring in the default Sphinx, numpy, or Google format, probably it could be even more helpful.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.