5.2.8 Soapbox

La prima parola in ``doctest'' � ``doc'' e per questo motivo l'autore ha scritto doctest: lo scopo era quello di fornire una documentazione aggiornata. É successo che doctest risulti un piacevole ambiente per l'unit testing (NdT: test per le unit� di codice), ma non era questo l'intento.

Scegliete gli esempi con attenzione. Esiste un'arte necessaria da imparare che all'inizio non risulter� molto naturale. Gli esempi dovrebbero valorizzare la documentazione. Un buon esempio pu� sostituire molte parole. Se possibile il manuale espone alcuni esempi normali, casi limiti, finezze ed esempi per ogni tipo di eccezione. Probabilmente proverete i casi limiti e le finezze in una shell: doctest cercher� di rendere il pi� semplice possibile la cattura della vostra sessione e verificher� continuamente il lavoro svolto ed il suo design.

Se gli esempi sono stati seguiti con cura, saranno di fondamentale importanza e vi ripagheranno per il tempo perso. Rimango ancora stupito nel vedere come i miei esempi di doctest perdano efficacia a seguito di piccoli cambiamenti.

Per test esaustivi, o elaborati casi che non aggiungono valore ai documenti, definite invece un dizionario __test__.

Vedete Circa questo documento... per informazioni su modifiche e suggerimenti.