Ruff rule links¶

pydocformatter is intended to own comment and docstring formatting, especially in situations where its PCF and PDF rules overlap with Ruff. In practice, configure Ruff to ignore its pydocstyle (D), pydoclint (DOC), and comment/docstring line-formatting rules. In special cases, where fine-grained exceptions to this advice are desired, use the rule tables far below for more details of exact relations between rules.

A canonical paired setup keeps shared formatting settings aligned where both tools rewrite the same syntax, disables the Ruff rules that pydocformatter replaces, and can use a shorter pydocformatter line length for readable prose than Ruff uses for long code lines:

[tool.pydocfmt]
line-length = 120
indent-style = "space"
indent-width = 4
line-ending = "lf"

[tool.ruff]
line-length = 200
indent-width = 4
output-format = "grouped"

[tool.ruff.format]
indent-style = "space"
line-ending = "lf"
quote-style = "double"

[tool.ruff.lint]
ignore = [
    "D",
    "DOC",
    "E261", "E262", "E265", "E266", "E501",
    "W505",
]
task-tags = ["TODO", "FIXME", "XXX", "HACK", "BUG", "DEBUG", "NOTE", "OPTIMIZE", "REVIEW"]

[tool.ruff.lint.flake8-quotes]
docstring-quotes = "double"
inline-quotes = "double"
multiline-quotes = "double"

[tool.ruff.lint.pycodestyle]
ignore-overlong-task-comments = true

line-length is intentionally not always shared: many projects use a shorter pydocformatter line length for docstring and comment paragraphs while allowing code lines to use Ruff's wider line length. E501 is included because Ruff's formatter only makes a best-effort attempt to fit its line-length; when formatter-adjacent lint rules or their parent categories are enabled, Ruff's formatter documentation recommends disabling conflicting lint rules through lint.ignore. ignore-overlong-task-comments = true lets Ruff keep task comments from fighting that policy when task comments are intentionally preserved or handled separately. Keep broader Ruff whitespace checks such as W293 enabled if you still want Ruff to check source outside the comment and docstring ranges that pydocformatter owns.

Ruff's W291 reports general trailing whitespace, including the spaces in a Markdown hard break, and can remove comment hard breaks. Disable or scope W291 where pydocformatter owns comment and docstring reflow, or use backslash hard breaks where both tools must coexist. Ruff marks fixes in multiline strings as unsafe; pydocformatter PDF102 instead preserves recognized hard breaks and removes only safely mapped ordinary trailing whitespace. Ruff D406 overlaps with PDF413 for NumPy-style section colons and with PDF102 only for ordinary trailing whitespace that is not a hard break.

The individual pydocformatter rule pages (e.g. PDF001) include Ruff compatibility sections with behavior-level notes. Also ensure to keep Ruff and pydocformatter line endings, indentation style, indentation width, task marker spellings, and any docstring quote policy intentionally aligned so the tools do not rewrite the same source back and forth. output-format = "grouped" keeps Ruff diagnostics visually consistent with pydocformatter's grouped output.

Ruff rules¶

pydocformatter rules¶

PCF: pydocformatter comment formatting¶

PDF: pydocformatter docstring formatting¶