Objetos documentables.
Nuevo tipEn Python, los objetos documentables (módulos, clases, métodos, funciones etc...) son todos aquellos objetos que a través del su atributo doc nos permitirán definir su respectiva documentación.
Para ello haremos uso de un docstring.
Para más info consulta el siguiente post
Ejemplo:
def promedio(*args):
"""
Calcula el promedio de una listado de números:
Párametros:
*args -- Listado de números enteros
La función retorna el promedio de la lista
"""
return sum(args) / len(args)
>>> help(promedio)
promedio(*args)
Calcula el promedio de una listado de números
Parámetros:
*args -- Listado de números enteros
La función retorna el promedio de la lista