Pydoc: добавление разделов - PullRequest
Новая
       8

Pydoc: добавление разделов

0 голосов
/ 08 ноября 2018

Я хотел бы улучшить документацию по моему модулю python с помощью дополнительных разделов.

Например, давайте рассмотрим это: 

$ cat test.py
"""Some module

This stuff goes to the "DESCRIPTION" section.
"""

Будет отображаться следующим образом: 

$ pydoc test
Help on module test:

NAME
    test - Some module

DESCRIPTION
    This stuff goes to the "DESCRIPTION" section.

FILE
    /tmp/tmp.XlLL4c82kb/test.py

Есть ли способ иметь раздел SYNOPSYS, где я могу показать некоторые примеры использования?

Что бы я хотел: 

$ pydoc test
Help on module test:

NAME
    test - Some module

SYNOPSYS
    import test
    test.foobar()

DESCRIPTION
    This stuff goes to the "DESCRIPTION" section.
...