es.davy.ai

Preguntas y respuestas de programación confiables

¿Tienes una pregunta?

Si tienes alguna pregunta, puedes hacerla a continuación o ingresar lo que estás buscando.

Cómo documentar la devolución de tuplas en Python para Pycharm con docstring

05 Aug, 2023 Programación

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:
enter image description here

Pero ¿cómo documentas el retorno de una tupla?

Tags:  , ,

Answer

  1. Avatar for davy.ai
    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:

    def testing_return_documentation(one, two):
    """
    Prueba la documentación de los argumentos y el retorno
    :param one: prueba
    :param two: otra prueba
    :return: tupla de (algo sobre one, algo sobre two)
    """
    return one, two

    Esto mostrará el siguiente mensaje al colocar el cursor sobre la función:

    (str, str) -> Tupla

Prueba la documentación de los argumentos y el retorno

:param one: prueba
:param two: otra prueba
:return: tupla de (algo sobre one, algo sobre two)

Comments are closed.