Skip to content

Commit 08a592f

Browse files
committed
style: reformat per black's 1-blank line after module docstring convention
1 parent ab715b8 commit 08a592f

22 files changed

Lines changed: 13 additions & 35 deletions

.pre-commit-config.yaml

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
exclude: 'tests/'
22
repos:
33
- repo: https://github.com/pre-commit/pre-commit-hooks
4-
rev: v5.0.0
4+
rev: v6.0.0
55
hooks:
66
- id: check-merge-conflict
77
- id: check-toml
@@ -11,28 +11,28 @@ repos:
1111
- id: no-commit-to-branch
1212
- id: trailing-whitespace
1313
- repo: https://github.com/pre-commit/pre-commit
14-
rev: v4.2.0
14+
rev: v4.5.1
1515
hooks:
1616
- id: validate_manifest
1717
- repo: https://github.com/psf/black
18-
rev: '25.1.0'
18+
rev: '26.3.1'
1919
hooks:
2020
- id: black
2121
types_or: [python, pyi]
2222
language_version: python3
2323
- repo: https://github.com/PyCQA/isort
24-
rev: 6.0.1
24+
rev: 8.0.1
2525
hooks:
2626
- id: isort
2727
args: [--settings-file, ./pyproject.toml]
2828
- repo: https://github.com/PyCQA/docformatter
29-
rev: v1.7.7
29+
rev: ab715b8e12b601ba392e7502898e500dde10b4e8
3030
hooks:
3131
- id: docformatter
3232
additional_dependencies: [tomli]
3333
args: [--in-place, --config, ./pyproject.toml]
3434
- repo: https://github.com/charliermarsh/ruff-pre-commit
35-
rev: 'v0.12.4'
35+
rev: 'v0.15.11'
3636
hooks:
3737
- id: ruff
3838
args: [ --config, ./pyproject.toml ]
@@ -43,13 +43,13 @@ repos:
4343
additional_dependencies: [toml]
4444
args: [--config, ./pyproject.toml]
4545
- repo: https://github.com/pre-commit/mirrors-mypy
46-
rev: v1.17.0
46+
rev: v1.20.1
4747
hooks:
4848
- id: mypy
4949
additional_dependencies: [types-python-dateutil]
5050
args: [--config-file, ./pyproject.toml]
5151
- repo: https://github.com/myint/eradicate
52-
rev: '3.0.0'
52+
rev: '3.0.1'
5353
hooks:
5454
- id: eradicate
5555
args: []

docs/source/conf.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@
77
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
88
"""Configuration file for the Sphinx documentation builder."""
99

10-
1110
project = "docformatter"
1211
copyright = "2022-2023, Steven Myint"
1312
author = "Steven Myint"

src/docformatter/__init__.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,6 @@
2626
# SOFTWARE.
2727
"""This is the docformatter package."""
2828

29-
3029
__all__ = ["__version__"]
3130

3231
# docformatter Local Imports

src/docformatter/__main__.py

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,6 @@
2626
# SOFTWARE.
2727
"""Formats docstrings to follow PEP 257."""
2828

29-
3029
# Standard Library Imports
3130
import contextlib
3231
import signal
@@ -39,8 +38,7 @@
3938

4039
def _help():
4140
"""Print docformatter's help."""
42-
print(
43-
"""\
41+
print("""\
4442
usage: docformatter [-h] [-i | -c] [-d] [-r] [-e [EXCLUDE ...]]
4543
[-n [NON-CAP ...]] [-s [style]] [--rest-section-adorns REGEX]
4644
[--black] [--wrap-summaries length]
@@ -108,8 +106,7 @@ def _help():
108106
(see issue #67) (default: False)
109107
--config CONFIG path to file containing docformatter options
110108
--version show program's version number and exit
111-
"""
112-
)
109+
""")
113110

114111

115112
def _main(argv, standard_out, standard_error, standard_in):

src/docformatter/__pkginfo__.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,5 +26,4 @@
2626
# SOFTWARE.
2727
"""Package information for docformatter."""
2828

29-
3029
__version__ = "1.7.7"

src/docformatter/classify.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,6 @@
2626
# SOFTWARE.
2727
"""This module provides docformatter's classification functions."""
2828

29-
3029
# Standard Library Imports
3130
import re
3231
import sys

src/docformatter/configuration.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,6 @@
2626
# SOFTWARE.
2727
"""This module provides docformatter's Configurater class."""
2828

29-
3029
# Standard Library Imports
3130
import argparse
3231
import contextlib

src/docformatter/constants.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,6 @@
2626
# SOFTWARE.
2727
"""This module provides docformatter's constants."""
2828

29-
3029
# TODO: Move these constants to the configuration file and/or command line.
3130
ABBREVIATIONS = (
3231
"e.g.",
@@ -200,8 +199,9 @@
200199
URL_SKIP_REGEX = rf"({URL_PATTERNS}):(/){{0,2}}(``|')"
201200
"""The regex used to ignore found hyperlinks.
202201
203-
URLs that don't actually contain a domain, but only the URL pattern should
204-
be treated like simple text. This will ignore URLs like ``http://`` or 'ftp:`.
202+
URLs that don't actually contain a domain, but only the URL pattern should be treated
203+
like simple text. This will ignore URLs like ``http://`` or
204+
'ftp:`.
205205
206206
({URL_PATTERNS}) matches one of the URL patterns.
207207
:(/){{0,2}} matches a colon followed by up to two forward slashes.

src/docformatter/encode.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,6 @@
2626
# SOFTWARE.
2727
"""This module provides docformatter's Encoder class."""
2828

29-
3029
# Standard Library Imports
3130
import collections
3231
import locale

src/docformatter/patterns/__init__.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,6 @@
2626
# SOFTWARE.
2727
"""This is the docformatter patterns package."""
2828

29-
3029
# docformatter Local Imports
3130
from .fields import * # noqa F403
3231
from .headers import * # noqa F403

0 commit comments

Comments
 (0)