Skip to content

Configure docformatter #412

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 14, 2023
Merged

Configure docformatter #412

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,15 @@ target-version = ['py37', 'py38', 'py39', 'py310', 'py311']
# diff = true


[tool.docformatter]
wrap-summaries = 80
close-quotes-on-newline = true
# make-summary-multi-line = true
black = true
pre-summary-newline = true
recursive = true


[tool.towncrier]
package = "semver"
package_dir = "src"
Expand Down
3 changes: 1 addition & 2 deletions src/semver/version.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,8 +64,7 @@ class Version:
See specification at https://semver.org.

:param major: version when you make incompatible API changes.
:param minor: version when you add functionality in a backwards-
compatible manner.
:param minor: version when you add functionality in a backwards-compatible manner.
:param patch: version when you make backwards-compatible bug fixes.
:param prerelease: an optional prerelease string
:param build: an optional build string
Expand Down
2 changes: 1 addition & 1 deletion tox.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ commands = mypy {posargs:--ignore-missing-imports --check-untyped-defs src}
description = Check for PEP257 compatible docstrings
basepython = python3
deps = docformatter
commands = docformatter --check --diff {posargs:--pre-summary-newline -r src}
commands = docformatter --check --diff {posargs:src}


[testenv:checks]
Expand Down