Skip to content

build(deps): bump PyCQA/docformatter from 1.7.7 to 1.7.8#25

Merged
cesarcoatl merged 1 commit into8.3from
build/deps/docformatter-1.7.8
Apr 21, 2026
Merged

build(deps): bump PyCQA/docformatter from 1.7.7 to 1.7.8#25
cesarcoatl merged 1 commit into8.3from
build/deps/docformatter-1.7.8

Conversation

@cesarcoatl
Copy link
Copy Markdown
Member

@cesarcoatl cesarcoatl commented Apr 21, 2026

Summary by Sourcery

Update formatting and tooling configuration to align with newer versions of docformatter and commitizen.

Enhancements:

  • Reflow and tweak docstrings and string literals to satisfy the updated docformatter style.

Build:

  • Bump docformatter pre-commit hook from v1.7.7 to v1.7.8 and adjust its configuration.
  • Update commitizen pre-commit hook from v4.13.9 to v4.13.10.

@sourcery-ai
Copy link
Copy Markdown

sourcery-ai Bot commented Apr 21, 2026

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Updates docformatter and commitizen pre-commit hooks and applies the updated docformatter style to a few docstrings and a string literal in the codebase.

File-Level Changes

Change Details Files
Bump docformatter pre-commit hook and relax its Python version configuration.
  • Update docformatter hook revision from v1.7.7 to v1.7.8 in pre-commit configuration
  • Remove explicit language_version override for the docformatter hook so it uses the default from pre-commit
.pre-commit-config.yaml
Bump commitizen pre-commit hook to the latest patch version.
  • Update commitizen hook revision from v4.13.9 to v4.13.10 in pre-commit configuration
.pre-commit-config.yaml
Apply new docformatter formatting rules to affected docstrings.
  • Split combined summary sentences in docstrings into a summary line and a separate paragraph where needed
  • Ensure blank line separation between summary and extended description in docstrings
src/system/bacnet/__init__.py
src/system/db.py
src/system/util.py
Adjust a string literal style to comply with the formatter.
  • Switch from triple-quoted string with double quotes to a single-quoted string for the format template in threadDump
src/system/util.py

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Copy Markdown

@sourcery-ai sourcery-ai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've found 1 issue

Prompt for AI Agents
Please address the comments from this code review:

## Individual Comments

### Comment 1
<location path=".pre-commit-config.yaml" line_range="37-39" />
<code_context>
-    rev: v1.7.7
+    rev: v1.7.8
     hooks:
       - id: docformatter
         files: ^src/
         args: [--config, tox.ini]
-        language_version: python3.12
   - repo: https://github.com/coatl-dev/flake8
</code_context>
<issue_to_address>
**question (bug_risk):** Consider whether removing `language_version: python3.12` for docformatter is intentional, as it may change which interpreter the hook runs under.

Without `language_version` set, pre-commit will fall back to its default interpreter resolution, which can vary by machine (e.g., different `python3` on PATH). If docformatter behavior or compatibility depends on Python 3.12, it’s safer to keep the explicit version to avoid environment‑dependent differences.
</issue_to_address>

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Comment thread .pre-commit-config.yaml
Comment on lines 37 to 39
- id: docformatter
files: ^src/
args: [--config, tox.ini]
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

question (bug_risk): Consider whether removing language_version: python3.12 for docformatter is intentional, as it may change which interpreter the hook runs under.

Without language_version set, pre-commit will fall back to its default interpreter resolution, which can vary by machine (e.g., different python3 on PATH). If docformatter behavior or compatibility depends on Python 3.12, it’s safer to keep the explicit version to avoid environment‑dependent differences.

@cesarcoatl cesarcoatl merged commit 31506b3 into 8.3 Apr 21, 2026
5 checks passed
@cesarcoatl cesarcoatl deleted the build/deps/docformatter-1.7.8 branch April 21, 2026 22:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant