Как заставить Pydoc документировать мои функции в определенном порядке?

Я хочу указать порядок, в котором Pydoc будет документировать мои функции. Я не уверен, как Pydoc упорядочивает функции в сгенерированной документации - это точно не текстовый порядок в модуле.

Это полезно, потому что я хотел бы затем указать мою printUsage() функцию, которая должна быть задокументирована первой.

"""
Sample module docstring
"""

def printUsage():
    """
    Command line usage: python my_module.py -i path/to/input_file.c
    If calling my_function() directly, pass the path/to/input_file.c as an arg.
    """
    print(printUsage.__doc__)

...

Так что, когда пользователь проверяет строку документации для my_module, он может быстро увидеть, как ее использовать.


python pydoc
person Saheel Godhane    schedule 26.02.2015    source источник

Ответы (1)


arrow_upward
1
arrow_downward

Глядя на исходный код:

Похоже, что документы модуля хранятся как dict, поэтому, когда они просматривают их, он создает случайный порядок:

def namelink(self, name, *dicts):
    """Make a link for an identifier, given name-to-URL mappings."""
    for dict in dicts:
        if name in dict:
            return '<a href="%s">%s</a>' % (dict[name], name)
person Tui Popenoe    schedule 27.02.2015
comment
Итак, я думаю, тупик? Или можно что-то подправить? - person Saheel Godhane; 27.02.2015
comment
Если вы хотите отредактировать исходный код, добро пожаловать в. - person Tui Popenoe; 28.02.2015