11.7 cadena de documentación Hasta ahora, nuestras funciones de ejemplo no han incluido ninguna cadena de documentación (la cadena de documentación). Esto se debe a que la cadena de documentación es opcional y las funciones que tenemos escrito han sido muy simples. Sin embargo, a medida que las funciones se vuelven más complejas y pueden tener múltiples parámetros la documentación proporcionada puede volverse más importante. La cadena de documentación permite que la función brinde orientación sobre lo que se espera en términos de los datos pasados ​​a los parámetros, ¿qué sucederá potencialmente si el los datos son incorrectos, así como cuál es el propósito de la función en primer lugar. En el siguiente ejemplo, la cadena de documentación se utiliza para explicar el comportamiento de la función y cómo se utiliza el parámetro. Cuando se usa, este método garantizará que se devolverá un entero válido al código de llamada: A continuación se muestra un ejemplo de lo que sucede cuando se ejecuta: def get_integer_input(mensaje): """ Esta función mostrará el mensaje al usuario. y solicite que ingresen un número entero. Si el usuario ingresa algo que no es un número entonces la entrada será rechazada y se mostrará un mensaje de error. Se le pedirá al usuario que vuelva a intentarlo.""" value_as_string = entrada (mensaje) mientras que no value_as_string.isnumeric(): print(‘La entrada debe ser un entero’) value_as_string = entrada (mensaje) devuelve int(valor_como_cadena) edad = get_integer_input(‘Ingrese su edad:’) print(’edad es’, edad) Por favor ingrese su edad: Juan La entrada debe ser un número entero. Por favor ingrese su edad: 21 la edad es 21 11.7 cadena de documentación 123