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

Question

Я хочу указать заказ, в котором 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, он может быстро увидеть, как использовать его.

Answer 1

Глядя на sourcecode:

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

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)