Automatic docstring word wrapping

[VolkerSiep]

My experience with VS Code and pylance so far is: If I miss a feature, it's just because I didn't find it yet. I assume the same to be the case here, that's why I'd like to ask carefully:

When writing docstrings (for using sphinx/autodoc), I would like the text to wrap lines and indent automatically for connected pieces of text. Ideally even, when editing the text, it should re-arrange the lines to avoid too long or unnecessarily short lines.

.. should be converted to ..

And, then, when I edit the comment:

... it should ideally rearrange it as follows:

Does this functionality already exist 😄 ?

[rchiodo]

Is this what you're looking for?

Setting that value to 'wordWrapColumn', it automatically wraps at the 80th column.

[rchiodo]

Granted that's not specific to doc strings. It applies to everything.

[VolkerSiep]

Hi, thanks for answering. But it's not really solving it, as this only wraps the view of the line, but the line is actually long, and pylint complains (and is imho right) about it.

So I was looking for something that splits and indents the line, so that the file content remains according to PEP standard - like other things get corrected with the "Format Selection" feature (which btw. leaves such long line comments in peace).

However, I must say, by writing the documentation with word-wrap enabled in connected paragraphs, it is then already much easier to just insert the line feeds when done.

[DevJake]

Anything on this? It'd be really helpful for when you're mass editing docstrings, to have those longer lines automatically folded to the correct length. I have tried extensions for this, but they seem to always struggle with lists, and code blocks

[rchiodo]

No, sorry it's not something we have on our backlog. I recommend adding an enhancement request to the discussions so people can up vote it.