Docstrings

Python · Unidad 19: Código limpio

Un docstring es un texto entre comillas triples en la primera línea del cuerpo de una función.

Dice qué hace, qué recibe y qué regresa. Python lo guarda, y se lee con __doc__.

def doble(n):
    """Regresa el doble de n."""
    return n * 2

print(doble.__doc__)

Imprime

Regresa el doble de n.

El resto de la explicación está en la lección, que es del plan completo.

Ejercicios de esta lección

Se hacen en la app, que los corrige al momento y explica por qué.

1. Predice la salida
¿Qué imprime este código?
2. Predice la salida
¿Qué imprime este código?
3. Completa el código
Completa para que la función traiga su descripción.
4. Encuentra el bug
El docstring dice qué debería hacer la función. ¿Qué línea tiene el error?
5. Opción múltiple
envio(compra) regresa lo que cuesta el envío. ¿Cuál docstring ayuda más?
6. Ordena las líneas
Ordena el programa. Baja el precio 10% e imprime también la descripción de la función.
7. Predice la salida
¿Qué imprime este código?
8. Predice la salida
¿Qué imprime este código?
9. Encuentra el caso que falla
Su docstring promete la inicial de cada texto, saltando los que vienen vacíos. ¿Con cuál llamada no lo cumple?
10. Encuentra el bug
El docstring promete regresar la suma. ¿Qué línea tiene el error?

Se abre en el navegador. Esta lección es del plan completo; la primera unidad de cada curso es gratis.