Skip to content

Add Docstring Formatting Checks #571

Description

@jonathan343

The use of docformatter was removed in #570 since it isn't supported in Python 3.14 and causing more problems than is helpful at the moment.

I'm creating this issue so we don't forget to do one of the following:

  • Add docformatter when a new version is released with Python 3.14 support
  • Enable the pydocstyle rules for ruff. I think this actually provides more coverage but more strict and will require extra work.
    • I prefer this approach since we don't need to introduce a new dependency, we should just stay on ruff

Important

This should be addressed for both hand-written smithy-python packages AND code generated smithy clients

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions