Форматирование Python строк документации для удобства чтения при печати

Question

Я только начал добавлять строки документов в мои классы / методы, и у меня возникают трудности с их форматированием, чтобы они легко читались при печати. Некоторые строки внутри строк документации достаточно длинные, чтобы обернуть их в моей IDE, и когда я печатаю строку документации в консоли, в этих разрывах появляются большие пробелы. Кроме того, я хотел бы поддерживать согласованную схему отступов для всей строки документации, но эти разрывы строк нарушают ее, заставляя строки печатать без отступа.

Существуют ли определенные рекомендации по написанию строк документации, которые я игнорирую? Существуют ли способы печати больших строк, обеспечивающие соблюдение форматирования?

Надеюсь, это имеет смысл, спасибо.

Answer 1

Обычно вы используете утилиту help для просмотра строк документации, она имеет дело с несогласованностью в пробелах:

>>> def test():
    """ first line
    HELLO THERE@
       ME TOO
    DOC STRING HERE
    """
    return 1

>>> help(test)
Help on function test in module __main__:

test()
    first line
    HELLO THERE@
       ME TOO
    DOC STRING HERE

>>> def test2():
    """
DOC string
text here"""
    return 5

>>> help(test2)
Help on function test2 in module __main__:

test2()
    DOC string
    text here

Поэтому, если вы можете обратиться к PEP 8 для обычных соглашений, вы Вы также можете просто решить, какой формат вам нравится, и просто попытаться согласовать его с вашим приложением.