Skip to content

Commit 90c3484

Browse files
authored
Configure docformatter (#412)
* Add config options to pyproject.toml * Call docformatter without any options in tox.ini as they are set in pyproject.toml now
1 parent 17bc257 commit 90c3484

File tree

3 files changed

+11
-3
lines changed

3 files changed

+11
-3
lines changed

pyproject.toml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,15 @@ target-version = ['py37', 'py38', 'py39', 'py310', 'py311']
2121
# diff = true
2222

2323

24+
[tool.docformatter]
25+
wrap-summaries = 80
26+
close-quotes-on-newline = true
27+
# make-summary-multi-line = true
28+
black = true
29+
pre-summary-newline = true
30+
recursive = true
31+
32+
2433
[tool.towncrier]
2534
package = "semver"
2635
package_dir = "src"

src/semver/version.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,8 +64,7 @@ class Version:
6464
See specification at https://semver.org.
6565
6666
:param major: version when you make incompatible API changes.
67-
:param minor: version when you add functionality in a backwards-
68-
compatible manner.
67+
:param minor: version when you add functionality in a backwards-compatible manner.
6968
:param patch: version when you make backwards-compatible bug fixes.
7069
:param prerelease: an optional prerelease string
7170
:param build: an optional build string

tox.ini

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ commands = mypy {posargs:--ignore-missing-imports --check-untyped-defs src}
5656
description = Check for PEP257 compatible docstrings
5757
basepython = python3
5858
deps = docformatter
59-
commands = docformatter --check --diff {posargs:--pre-summary-newline -r src}
59+
commands = docformatter --check --diff {posargs:src}
6060

6161

6262
[testenv:checks]

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy