docstring

6calore

2risposta

Come posso produrre una documentazione simile a numpy?

Sto lavorando molto con Spyder e l'ispettore degli oggetti, che trovo piuttosto comodo come funzione di aiuto istantaneo. Alcuni moduli sembrano beneficiare molto bene di questa funzione. Per esempio

24calore

2risposta

nome della funzione + scheda non restituisce docstring in IPython

In IPython, sono abituato a scrivere funzione ( e poi colpire una linguetta, e ottenere il contenuto della docstring ed un elenco degli argomenti denominati. Tuttavia, questo ha smesso di funzionare d

5calore

2risposta

Come potrei stampare una docstring python?

Ho un file python con stringhe non elaborate come docstring. def a(): '\n\tthis\n\tis\n\tthe docstring.\n\t' print 'hello world' come faccio a riscrivere la docstring per assomigliare def

11calore

1risposta

Come documentare la funzione fortran per f2py?

Vorrei usare docstring o qualcosa di simile per documentare le mie routine fortran che possono essere utilizzabili con il comando python help. La docgging generata automaticamente da f2py non è suffic

7calore

1risposta

Come faccio a evitare che Sphinx ignori l'avviso GPL nella mia docstring?

Sto usando Sphinx per documentare il mio pacchetto Python. Quando uso la direttiva automodule sul mio modulo: .. automodule:: mymodule :members: viene stampato tutto, compreso il bando GPL nella do

17calore

4risposta

Docstrings vs Commenti

Sono un po 'confuso sulla differenza tra docstring e commenti in python. Nella mia classe il mio insegnante ha introdotto qualcosa di noto come "ricetta del design", una serie di passaggi che presumib

6calore

1risposta

Come aggiungere python docstring per dict

Qual è il modo consigliato di aggiungere una docstring per un parametro del dizionario? Riesco a vedere più esempi doc-string here. Devo documentare gli argomenti di input a una funzione nella docstri

5calore

2risposta

Python 3 - Metodo di ereditarietà di docstring senza rompere decoratori o violazione di DRY

Questa domanda sembra venire regolarmente sia su StackOverflow che altrove, tuttavia non sono stato in grado di trovare una soluzione completamente soddisfacente. Sembrano esserci due tipi di soluzion

14calore

1risposta

PEP 257 assestamento docstring nella libreria standard?

PEP 257 dice: strumenti di elaborazione docstring elimineranno una quantità uniforme di rientro dal secondo e ulteriori linee della docstring, pari al rientro minimo di tutte le linee non vuote dopo l

11calore

3risposta

In Django RestFramework, come modificare la documentazione di Api Root?

In django RestFramework, esiste un modo "ufficiale" per generare la documentazione per "Api Root"? Dopo aver guardato il codice sorgente del RestFramework, ho trovato un lavoro in giro per la sottocla