我想通过其他部分来完善我的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.