From f7643e0a857646f81d052a9b21fbd1cc3cb10aaa Mon Sep 17 00:00:00 2001 From: Martin Walters <104021577+waltersma@users.noreply.github.com> Date: Mon, 7 Jul 2025 15:34:56 +0100 Subject: [PATCH 1/4] Update .pre-commit-config.yaml --- .pre-commit-config.yaml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index e17bb09cb3..521abde3b2 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -21,6 +21,7 @@ repos: rev: 6.0.0 hooks: - id: flake8 + additional_dependencies: [flake8-docstrings] - repo: https://github.com/pycqa/isort rev: 5.12.0 @@ -54,4 +55,4 @@ repos: hooks: - id: add-license-headers args: - - LICENSE \ No newline at end of file + - LICENSE From 1241064255cd2d4ab6fd0f073edaf4497cf3660b Mon Sep 17 00:00:00 2001 From: pyansys-ci-bot <92810346+pyansys-ci-bot@users.noreply.github.com> Date: Mon, 7 Jul 2025 14:36:41 +0000 Subject: [PATCH 2/4] chore: adding changelog file 1078.miscellaneous.md [dependabot-skip] --- doc/changelog.d/1078.miscellaneous.md | 1 + 1 file changed, 1 insertion(+) create mode 100644 doc/changelog.d/1078.miscellaneous.md diff --git a/doc/changelog.d/1078.miscellaneous.md b/doc/changelog.d/1078.miscellaneous.md new file mode 100644 index 0000000000..c27977d672 --- /dev/null +++ b/doc/changelog.d/1078.miscellaneous.md @@ -0,0 +1 @@ +Fix: docstring example style \ No newline at end of file From e4c7da500b27ec647ef5d41dd31b47d600d5e070 Mon Sep 17 00:00:00 2001 From: Martin Walters <104021577+waltersma@users.noreply.github.com> Date: Mon, 7 Jul 2025 15:55:23 +0100 Subject: [PATCH 3/4] Update .pre-commit-config.yaml --- .pre-commit-config.yaml | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 521abde3b2..c6b55003b2 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -16,12 +16,19 @@ repos: hooks: - id: blacken-docs additional_dependencies: [black==22.12.0] + # Extend to handle Python docstrings in addition to documentation files + files: \.(py|pyi|md|rst|tex)$ + +- repo: https://github.com/PyCQA/docformatter + rev: v1.7.5 + hooks: + - id: docformatter + args: [--in-place, --wrap-summaries=79, --wrap-descriptions=79, --make-summary-multi-line] - repo: https://github.com/PyCQA/flake8 rev: 6.0.0 hooks: - id: flake8 - additional_dependencies: [flake8-docstrings] - repo: https://github.com/pycqa/isort rev: 5.12.0 From ab2d22ef1d60702f9d6364988fd19d1b8af5006a Mon Sep 17 00:00:00 2001 From: Martin Walters <104021577+waltersma@users.noreply.github.com> Date: Mon, 7 Jul 2025 16:03:35 +0100 Subject: [PATCH 4/4] Update .pre-commit-config.yaml --- .pre-commit-config.yaml | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index c6b55003b2..b961f14f86 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -16,14 +16,22 @@ repos: hooks: - id: blacken-docs additional_dependencies: [black==22.12.0] - # Extend to handle Python docstrings in addition to documentation files - files: \.(py|pyi|md|rst|tex)$ + args: [--line-length=88] - repo: https://github.com/PyCQA/docformatter rev: v1.7.5 hooks: - id: docformatter - args: [--in-place, --wrap-summaries=79, --wrap-descriptions=79, --make-summary-multi-line] + args: [--in-place, --wrap-summaries=88, --wrap-descriptions=88, --make-summary-multi-line] + +- repo: https://github.com/asottile/blacken-docs + rev: v1.12.1 + hooks: + - id: blacken-docs + name: blacken-docs-python + additional_dependencies: [black==22.12.0] + files: \.py$ + args: [--line-length=88] - repo: https://github.com/PyCQA/flake8 rev: 6.0.0