Skip to content
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.

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

Request: docformatter autofixing #4112

Closed
jamesbraza opened this issue Apr 26, 2023 · 1 comment · Fixed by #4117
Closed

Request: docformatter autofixing #4112

jamesbraza opened this issue Apr 26, 2023 · 1 comment · Fixed by #4117
Assignees
Labels
question Asking for support or clarification

Comments

@jamesbraza
Copy link
Contributor

#1335 talks about adding docformatter support. Then it seems to get distracted by pydocstyle discussions and closed.

As of ruff==0.0.263, the README.md makes no mention of docformatter rules.

The request is to:

  • Implement docformatter with autofixes (starting point is docformatter --in-place)
  • Document it in the README.md and docs
@charliermarsh
Copy link
Member

Our support for docformatter is such that we have autofix enabled for the pydocstyle rules -- so, like autoflake, it doesn't fit cleanly into our existing documentation structures. I think I'll settle for this issue itself as the answer to the question, though open to other ways to clarify it.

@charliermarsh charliermarsh added the question Asking for support or clarification label Jun 2, 2023
@charliermarsh charliermarsh self-assigned this Jun 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Asking for support or clarification
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants