Documentació i test
===================

Conceptes
~~~~~~~~~

- documentació de funcions, :term:`docstring`, :term:`funció` :func:`help`
- diferència entre *docstring* i comentari
- prova o test d'una funció
- :term:`exemple interactiu`
- :term:`fitxer de text` amb exemples interactius, :term:`joc de proves`
- :term:`mòdul` :mod:`doctest`, funció :func:`~doctest.testfile`
- ús de :mod:`doctest` des de l\':term:`intèrpret d'ordres del sistema
  operatiu`, mode xerraire (*verbose*), aturada ràpida (*fail fast*)


Referències
~~~~~~~~~~~

- :doc:`/laboratori/doctest/doctest`

..

- Seccions 5.6 a 5.8 del llibre `Introducció a la programació
  <https://www.cs.upc.edu/~tonis/inf/intprog.pdf>`__
- Documentació del mòdul :mod:`doctest` a :doc:`python:library/index`.