Revisar un cambio y proponer mejoras

Llevas un mes en el equipo. Marta, una compañera, te pide que revises su cambio antes de publicarlo.

Son diez líneas. No sabes si eres quién para opinar. Pero revisar es parte del trabajo de todo el equipo, también de quien acaba de llegar. Y una segunda mirada encuentra cosas que el autor no ve.

Una revisión sigue un orden. Lo primero es saber si el cambio hace lo que promete. Ejecútalo o lee sus pruebas.

Después mira si se entiende: los nombres, el tamaño de las funciones. Por último, piensa en los datos raros: una lista vacía, un cero, un texto con espacios.

Ejecuta el cambio de Marta y léelo con ese orden.

# Cambio propuesto por Marta: "Media de valoraciones de un restaurante"
def m(l):
    t = 0
    for x in l:
        t = t + x
    return t / len(l)


print(m([5, 4, 4, 3]))  # un restaurante con cuatro opiniones

Los nombres ya están arreglados. Ahora haz la pregunta que más fallos evita: ¿qué pasa con un dato raro?

Un restaurante que acaba de abrir no tiene opiniones. La lista está vacía. Dividir entre len(ratings) es dividir entre cero.

Ejecuta el bloque, lee el error y añade la comprobación que se propone.

def average_rating(ratings):
    total = 0
    for rating in ratings:
        total = total + rating
    return total / len(ratings)


print(average_rating([5, 4, 4, 3]))
print(average_rating([]))  # un restaurante que acaba de abrir

# Lee el error. Después añade al principio de la función:
#     if len(ratings) == 0:
#         return 0
# y pulsa Ejecutar otra vez.

Un buen comentario dice dónde, qué y por qué. Si puedes, propone cómo.

Habla del código y no de la persona. Pregunta cuando no estés seguro. Separa lo que bloquea el cambio de lo que es una sugerencia.

Y di también lo que está bien. Ayuda a saber qué conservar.