CKTIS / Python
function.__doc__
Este atributo contiene la documentación de la función o None si no tiene docstring.
Versión: Python 3.14; repository image, production runtime not attested
Sintaxis
documentation = function.__doc__Este atributo contiene la documentación de la función o None si no tiene docstring.
function.__doc__
Un literal de cadena como primera instrucción proporciona la documentación. Escribir mediante un alias cambia los metadatos del mismo objeto sin cambiar el cuerpo.
plain tiene None y area(3) sigue dando 9 tras editar la descripción.
def f():
n=1
"Late string."
assert f.__doc__ is None
f.__doc__='text'
assert f.__doc__=='text'
Ejemplos
def area(n):
"""Return the area of a square."""
return n*n
def plain(): pass
alias = area
print(area.__doc__, plain.__doc__)
alias.__doc__ = "Area in cm²."
print(area.__doc__, area(3))
Resultado
Return the area of a square. None Area in cm². 9
plain tiene None y area(3) sigue dando 9 tras editar la descripción.