How do I format docstrings

Avatar
Permanently deleted user
Created
Probably overlooking something very basic, but I'd like to just format (mainly wrap/re-wrap) my docstrings.  Thanks!

Votes

0

Share

5 comments
Avatar
Serge Baranov
Created
There is Fill Paragraph action that you can assign a shortcut to: http://img580.imageshack.us/img580/8996/yz1l.png. See this request for more details: http://youtrack.jetbrains.com/issue/PY-4775.
0
Avatar
Permanently deleted user
Created
That doesn't seem to do anything.  I have some docstring highlighted but Fill Paragraph seems to have no effect....
0
Avatar
Serge Baranov
Created
Please provide a sample file to reproduce.
0
Avatar
Permanently deleted user
Created
Apologies - the wrap limit was simply wider than I expected. Thanks!
0
Avatar
Permanently deleted user
Created
Actually - unfortunately it seems that the formatting is not aware of the ReST/Sphinx syntax, which is the Python standard docstring language.

http://sphinx-doc.org/markup/desc.html

Fill Paragraph will merge lines that should be separate and not properly indent continuation lines.

There wouldn't happen to be any way to format the docstrings appropriately would there?
0

Please sign in to leave a comment.