отступ многострочной строки

Question

У меня есть скрипт, который использует модуль Python cmd. В качестве текста справки модуль cmd использует многострочную строку с тройными кавычками. Как то так

def x(self, strags = None):
    """class
    help text here
    and some more help text here"""

При запуске скрипта команда help x выведет строку. Однако он будет печатать и новые строки перед последними двумя строками. Я могу преодолеть это, не отступая от этих строк, но это сделает мой код уродливым.

Как преодолеть эту проблему? Как профессиональные кодеры Python справляются с этим?

Answer 1

Лично я стараюсь следовать PEP 8 , что отсылает читателя к PEP 257 для Условных обозначений. В нем есть целый раздел, посвященный многострочным строкам документации.

Answer 2

Я бы справился с этим с помощью последовательных отступов, например:

def x(self, strags = None):
    """
    class
    help text here
    and some more help text here
    """

Конечно, это занимает еще две строки, но это также вносит ясность (на мой взгляд), делая комментарий к документу достаточно заметным.