Per rendere la tua documentazione altrettanto gradevole con quella numpy, è necessario seguire lo standard NumpyDoc. Supponiamo di avere una funzione chiamata func
con due argomenti come questo:
def func(arg1, arg2):
return True
Per aggiungere la documentazione ad esso è necessario scrivere una stringa multilinea sotto la sua definizione (chiamato nel mondo Python docstring), come questo
def func(arg1, arg2):
"""Summary line.
Extended description of function.
Parameters
----------
arg1 : int
Description of arg1
arg2 : str
Description of arg2
Returns
-------
bool
Description of return value
Examples
--------
>>> func(1, "a")
True
"""
return True
Ciò che Spyder fa è che prende questa descrizione in testo semplice, lo analizza e lo restituisce come html e infine lo mostra nell'Object Inspector.
Per vederla basta chiamare func
da qualche altra parte nel codice e premere Ctrl + i accanto ad essa, in questo modo:
func<Ctrl+i>(1, "a")
Ciò è dimostrato anche automaticamente quando si scrive un parentesi sinistra accanto a func
.
fonte
2014-07-03 14:55:45
numpydoc è assolutamente incredibile e qualcosa che più progetti dovrebbero adottare – daniel
Assolutamente! Quasi tutti i progetti scientifici Python lo usano, ma penso che l'Object Inspector di Spyder incoraggia un pubblico molto più ampio ad adottarlo anche nel suo codice. –
È possibile visualizzare la documentazione rapida (in PyCharm) facendo clic sulla definizione della funzione (senza chiamarla altrove) e premendo CTRL + Q (su Windows). Potrebbe funzionare in modo simile in altri IDE o OS. Saluti! –