8
8
9
9
A tool to automatically format Python docstrings to follow recommendations from
10
10
[ ` PEP 8 ` ] ( https://www.python.org/dev/peps/pep-0008/ ) and
11
- [ ` PEP 257 ` ] ( https://www.python.org/dev/peps/pep-0257/ ) (or other supported style guides.)
11
+ [ ` PEP 257 ` ] ( https://www.python.org/dev/peps/pep-0257/ ) (or other supported style
12
+ guides.)
12
13
13
14
See [ What it does] ( #what-it-does ) for currently supported auto-formatting.
14
15
@@ -19,8 +20,9 @@ This project is heavily inspired by
19
20
20
21
When this project was started ` docformatter ` did not meet all of the requirements the
21
22
[ ` pylint ` ] ( https://github.com/PyCQA/pylint ) project had for its docstring formatter and
22
- was no longer actively maintained (this has changed since then). Therefore, some contributors
23
- of ` pylint ` got together and started working on our own formatter to fulfill our needs.
23
+ was no longer actively maintained (this has changed since then). Therefore, some
24
+ contributors of ` pylint ` got together and started working on our own formatter to
25
+ fulfill our needs.
24
26
25
27
When asked we defined the objective of the tool as:
26
28
@@ -62,9 +64,9 @@ exclude = ["**/my_dir/**", "**/my_other_dir/**"]
62
64
63
65
#### Style
64
66
65
- Pydocstringformatter can be configured to use a specific style. The default is `` pep257 `` but
66
- we support other styles as well.
67
- These can also be used at the same time. For example with:
67
+ Pydocstringformatter can be configured to use a specific style. The default is ` pep257 `
68
+ but we support other styles as well. These can also be used at the same time. For
69
+ example with:
68
70
69
71
``` console
70
72
pydocstringformatter --style=pep257 --style=numpydoc myfile.py
@@ -84,8 +86,9 @@ Add the following to your `.pre-commit-config.yaml` file:
84
86
85
87
## What it does
86
88
87
- The following examples show some of the changes pydocstringformatter will apply. For a full
88
- overview of all potential changes you can check out the [` Usage`](https://pydocstringformatter.readthedocs.io/en/latest/usage.html) page which
89
+ The following examples show some of the changes pydocstringformatter will apply. For a
90
+ full overview of all potential changes you can check out the
91
+ [` Usage`](https://pydocstringformatter.readthedocs.io/en/latest/usage.html) page which
89
92
shows an up to date list of all formatters and their description.
90
93
91
94
` ` ` python
@@ -129,7 +132,6 @@ multi-line docstring
129
132
"""
130
133
` ` `
131
134
132
-
133
135
# # Development
134
136
135
137
For development and contributing guidelines please see
0 commit comments