Skip to content

Commit f5a663b

Browse files
pre-commit autoupdate and formatting changes
* [pre-commit.ci] pre-commit autoupdate updates: - [github.com/myint/autoflake: v1.4 → v1.5.1](PyCQA/autoflake@v1.4...v1.5.1) - [github.com/pycqa/pylint: v2.14.5 → v2.15.0](pylint-dev/pylint@v2.14.5...v2.15.0) - [github.com/DanielNoord/pydocstringformatter: v0.7.0 → v0.7.1](v0.7.0...v0.7.1) * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
1 parent 545bc62 commit f5a663b

File tree

2 files changed

+14
-12
lines changed

2 files changed

+14
-12
lines changed

.pre-commit-config.yaml

+3-3
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ repos:
1010
- id: check-toml
1111
exclude: &test-data "tests/data"
1212
- repo: https://github.com/myint/autoflake
13-
rev: v1.4
13+
rev: v1.5.1
1414
hooks:
1515
- id: autoflake
1616
exclude: *test-data
@@ -42,7 +42,7 @@ repos:
4242
exclude: *test-data
4343
additional_dependencies: [flake8-typing-imports==1.10.1]
4444
- repo: https://github.com/pycqa/pylint
45-
rev: v2.14.5
45+
rev: v2.15.0
4646
hooks:
4747
- id: pylint
4848
exclude: *test-data
@@ -56,7 +56,7 @@ repos:
5656
additional_dependencies:
5757
[pytest-stub==1.1.0, types-docutils~=0.17.5, sphinx~=4.4]
5858
- repo: https://github.com/DanielNoord/pydocstringformatter
59-
rev: v0.7.0
59+
rev: v0.7.1
6060
hooks:
6161
- id: pydocstringformatter
6262
exclude: *test-data

README.md

+11-9
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@
88

99
A tool to automatically format Python docstrings to follow recommendations from
1010
[`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.)
1213

1314
See [What it does](#what-it-does) for currently supported auto-formatting.
1415

@@ -19,8 +20,9 @@ This project is heavily inspired by
1920

2021
When this project was started `docformatter` did not meet all of the requirements the
2122
[`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.
2426

2527
When asked we defined the objective of the tool as:
2628

@@ -62,9 +64,9 @@ exclude = ["**/my_dir/**", "**/my_other_dir/**"]
6264

6365
#### Style
6466

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:
6870

6971
```console
7072
pydocstringformatter --style=pep257 --style=numpydoc myfile.py
@@ -84,8 +86,9 @@ Add the following to your `.pre-commit-config.yaml` file:
8486
8587
## What it does
8688
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
8992
shows an up to date list of all formatters and their description.
9093

9194
```python
@@ -129,7 +132,6 @@ multi-line docstring
129132
"""
130133
```
131134

132-
133135
## Development
134136

135137
For development and contributing guidelines please see

0 commit comments

Comments
 (0)