Do not flag docstrings and comments lines with E501(linz-too-long) warnings

[vianmixtkz]

Ruff flags my docstrings and comments line that go over the specified limits with E501 and I don't like that.
How can I configure Ruff so that it ignores docstrings and comments when counting the number of characthers ?

I don't want it to flag my docstrings with lines that go over 80 characthers or lines that are pure comments line (i.e that starts with #) or even mixed lines (i.e lines that start with code and finishes with a comment)

[dhruvmanila]

Line length for docstrings and comments can be updated using max-doc-length option which is independent to the line-length option.

[tool.ruff]
select = ["E", "W"]
line-length = 88

[tool.ruff.pycodestyle]
max-doc-length = 79

As for the mixed lines which contains trailing comments, it seems like only E501 is triggered when it goes beyond the line-length limit. The W505 won't be triggered even if it goes beyond the max-doc-length range. Is this the expected behavior? @charliermarsh

[charliermarsh]

(And yes, it's intentional that "doclines" does not include end-of-line comments, which is consistent with Flake8.)

[vianmixtkz]

I used the following configuration

[tool.ruff]
select = ["E", "F", "D100", "D101", "D102", "D103", "D104", "D105", "D106"]
line-length = 120

[tool.ruff.pycodestyle]
max-doc-length = 200

[charliermarsh]

I think you need to add W to your select, since this rule is under W505.

However, in reviewing how W505 works, I realized that it won't actually give you the behavior you want. We mirror Flake8's behavior, whereby if a docstring line exceeds the max-doc-length, we flag it as both E501 and W505. The rule exists to enforce a recommendation in PEP 8, whereby docstrings are recommended to adhere to 72 characters, while "regular code" can be up to 79, so it works okay for that purpose, but it won't work at all for the case in which docstrings are allowed to be longer than "regular code".

[VianneyMI]

I think PEP 8 is obsolete regarding line length.
Do you think you can provide a solution ?
I integrated Ruff in my CI with reviewdog and it's kind of painful to have hundreds of warnings for lines that are too long. When 95% of them are coming from the cases I described above (docstrings and comments).

(it's still @vianmixtkz but from a different account)

[dekoza]

@vianmixtkz @VianneyMI can you share your reviewdog ruff config?