How to get PyCharm to display docstring in proper format?

1

In PyCharm 2017.2.3, I used reStructuredText format for Python docstring.

docstring for method

And it did not display properly. Any idea how to fix it?

docstring display

Dio Phung

Posted 2017-09-28T18:32:21.873

Reputation: 739

Answers

1

I believe there should be an empty line before first :param to separate description. It fixed formatting for me.

Pavel Karateev

Posted 2017-09-28T18:32:21.873

Reputation: 181

Sweet, that single empty line is the key. Thanks. – Dio Phung – 2017-09-29T10:01:59.007

Asked: 2017-09-28T18:32:21.873

Viewed: 946 times

Active: 2017-09-29T07:25:29.840