5.2.6 Come vengono riconosciuti gli esempi nelle stringhe di documentazione?

Nella maggior parte dei casi copiare ed incollare l'output di una sessione interattiva è sufficiente -- accertatevi solamente che gli spazi di inizio riga siano rigidamente consistenti (potreste essere troppo pigri per farlo in maniera coerente, potreste usare sia tabulazioni che spazi, ma doctest non è in grado di capire qual'è il significato che voi date alle tabulazioni).

>>> # i commenti vengono ignorati
>>> x = 12
>>> x
12
>>> if x == 13:
...     print "si"
... else:
...     print "no"
...     print "NO"
...     print "NO!!!"
...
no
NO
NO!!!
>>>

Ogni output atteso deve seguire immediatamente i '>>> ' o '... ' successivi alla riga finale contenente il codice, e l'output atteso (se è previsto) si estende fino al successivo '>>> ' o a tutte le righe vuote.

Per una stampa corretta:

L'output atteso non può contenere una riga di spazi vuoti, dato che una riga di questo tipo è usata come segnale per la fine dell'output atteso.
Viene catturato l'output sullo standard output, ma non quello verso lo standard error (le traceback delle eccezioni sono catturate in maniera diversa).
Se continuate una riga con un backslash in una sessione interattiva, o per qualsiasi ragione usate un backslash, nelle docstring dovete raddoppiarlo. Questo è dovuto semplicemente al fatto che siete in una stringa, e quindi deve essere anteposto il carattere di escape a fronte di un backslash per renderlo riconoscibile. Come:
```
>>> if "si" == \\
...     "s" +   \\
...     "i":
...     print 'si'
si
```
La colonna iniziale non conta:
```
  >>> assert "Easy!"
        >>> import math
            >>> math.floor(1.9)
            1.0
```
e viene eliminato dall'output atteso un numero di spazi vuoti iniziali pari a quelli presenti nella prima riga con '>>> ' che ha scatenato il processo.

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