mirror of
https://github.com/vale981/apheleia
synced 2025-03-05 09:31:40 -05:00
4a87523f80
Add [docformatter](https://github.com/PyCQA/docformatter) for Python docstrings. By default it outputs diffs but changes in-place with `--in-place`. On successful change it exits with an error code of `3` (found out by trial), so I had to add a formatter wrapping-script. Initially I used `--in-place` with the special `in-place` symbol in apheleia. But now I tried an approach where I transform the diff into usable stdout using `patch` instead. Related to #266 , where I had used the example of docformatter to ask how to add scripts with positive exit codes and @raxod502 showed me the `phpcs` solution. --------- Co-authored-by: Radon Rosborough <radon@intuitiveexplanations.com>
30 lines
987 B
Python
30 lines
987 B
Python
def single_line_doc():
|
|
"""Line break not necessary."""
|
|
|
|
|
|
def extend_first_line():
|
|
"""First line first line continuation."""
|
|
|
|
|
|
def add_line_break():
|
|
"""First line.
|
|
|
|
Second line.
|
|
"""
|
|
|
|
|
|
def long_lines():
|
|
"""Nullam eu ante vel est convallis dignissim.
|
|
|
|
Fusce suscipit, wisi nec facilisis facilisis, est dui fermentum leo,
|
|
quis tempor ligula erat quis odio. Nunc porta vulputate tellus.
|
|
Nunc rutrum turpis sed pede. Sed bibendum. Aliquam posuere. Nunc
|
|
aliquet, augue nec adipiscing interdum, lacus tellus malesuada
|
|
massa, quis varius mi purus non odio. Pellentesque condimentum,
|
|
magna ut suscipit hendrerit, ipsum augue ornare nulla, non luctus
|
|
diam neque sit amet urna. Curabitur vulputate vestibulum lorem.
|
|
Fusce sagittis, libero non molestie mollis, magna orci ultrices
|
|
dolor, at vulputate neque nulla lacinia eros. Sed id ligula quis
|
|
est convallis tempor. Curabitur lacinia pulvinar nibh. Nam a
|
|
sapien.
|
|
"""
|