2013-06-29 6 views
7

Ich habe folgendes docstring:des Make Sphinx Autodoc zeigen Standardwerte der Parameter Beschreibung

def progress_bar(progress, length=20): 
    ''' 
    Returns a textual progress bar. 

    >>> progress_bar(0.6) 
    '[##########--------]' 

    :param progress: Number between 0 and 1 describes the progress. 
    :type progress: float 
    :param length: The length of the progress bar in chars. Default is 20. 
    :type length: int 
    :rtype: string 
    ''' 

Gibt es eine Möglichkeit sphinx zu sagen, die ‚Default ist X‘ Teil, um die Parameter hinzufügen Beschreibung falls vorhanden?

Antwort

2

Dies ist nicht möglich und muss manuell durchgeführt werden.

Verwandte Themen