72 char docstrings

[Simon-1-1]

Make doc strings PEP8 compliant.

[plaos]

I'm actually quite hesitant regarding this. I do like it for the doc comments, but I really don't like that it forces all comments to be 72 characters. Is there any way at all we could make it so that only doc comments are affected?

[Simon-1-1]

I don't mind it for ordinary comments.

There is no way to configure it to not go for ordinary comments. But you could fork flake8-docstrings. It's just a plugin to flake8

[plaos]

Maybe, but I don't think we'll get around to that.

But what's your thought on the scenarios in which you have a method in a class, and a few nested loops/if-statements? The cases in which you only have something like 10-20 characters to write a comment? I think that harms readability more than the 72 character limit helps it for doc comments.

[Simon-1-1]

I think that it keeps us in check so that we don't have 10 levels of nesting

[Simon-1-1]

So what do you think?

[plaos]

I'm still not sold on it, I don't think the allowed width of a comment will keep us in check regarding multiple indentations. Also it seems a bit confusing to have different limits for code and comments, wouldn't it be difficult to have editor support for it? Do you have any arguments for why we want this?

[Simon-1-1]

I'm still not sold on it, I don't think the allowed width of a comment will keep us in check regarding multiple indentations. Also it seems a bit confusing to have different limits for code and comments, wouldn't it be difficult to have editor support for it? Do you have any arguments for why we want this?

Yes, PEP8 requires it:

For flowing long blocks of text with fewer structural restrictions (docstrings or comments), the line length should be limited to 72 characters.

https://peps.python.org/pep-0008/#maximum-line-length

[plaos]

Seeing as it actually is in the PEP standard, I'm inclined to fold. I'll take another look at the changes.

[plaos]

Looks good overall.