Skip to content

Enforce docformatter compatibility #308

@sbrandstaeter

Description

@sbrandstaeter

Description of the Issue:

docformatter is currently executed as part of the pre-commit hooks for changed files, but it is not included in the regular code quality checks/workflows.

Running docformatter across the entire codebase currently produces a large number of formatting changes, indicating that the repository is not fully compliant with the configured formatting rules.

Unresolved / Open Questions

  • There are occasional compatibility issues between docformatter and black, where formatting changes may conflict or produce unstable formatting results.
  • The formatting configuration and execution order may need to be reviewed to minimize conflicts between the tools.

Proposed Solution:

  1. Run docformatter once across the entire codebase and commit all resulting formatting changes.
  2. Add docformatter to the code quality workflow/CI checks to ensure continued compliance and prevent future drift.

Action Items:

No response

Related Issues:

No response

Interested Parties:

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    status: openNo solution for this issue has been providedtopic: actionsIssue/PR related to GitHub Actionstopic: documentationIssue/PR related to the documentationtopic: testingIssue/PR related to testing and pytesttype: clean codeIssue/PR related to clean coding and pythonics
    No fields configured for Feature.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions