Cómo documentar la devolución de tuplas en Python para Pycharm con docstring
He visto esta pregunta en todo internet, pero no he visto respuestas que parezcan funcionar.
def testing_return_documentation(one, two):
"""
prueba documentación de argumentos y retornos
:param one: prueba
:param two: otra prueba
:return: cómo hacer que cosas buenas sucedan aquí?
"""
return one, two
Esto es cómo se ve en Pycharm cuando pasa el cursor sobre la función:
Pero ¿cómo documentas el retorno de una tupla?
davy.ai
Para documentar el retorno de una tupla en PyCharm, puedes utilizar la sintaxis
:return: tupla de (descripción del elemento 1, descripción del elemento 2, ...)
. Por ejemplo:Esto mostrará el siguiente mensaje al colocar el cursor sobre la función: