Etiqueta de la cadena de documentación para la palabra clave “rendimiento”

Hay algunas tags para cadenas de documentación en python, como @param y @return , por ejemplo:

 def my_method(a_param): ''' @param a_param: Description of this param @return: The return value of the method ''' return int(a_param) * (other or 1) 

¿Qué puedo usar para documentar generadores? especialmente la palabra clave de yield , como:

 def my_generator(from=0): ''' @param from: The initial value @yield: A lot of values ''' yield a_value 

Entiendo que @return an iterator puede usarse @return an iterator aquí, pero no sé si es correcto porque un generador también puede devolver valores.

Gracias.

    Consideraría que @return es apropiado en este caso porque la función en realidad devuelve un objeto iterador con un método next o de send . La validez de la statement x = my_generator(from=3) implica que my_generator realmente devuelve algo. Simplemente lo hace sin usar la statement de return para hacerlo.

    De alguna manera, las funciones que contienen una statement o expresión de yield comportan como clases, porque son fábricas que devuelven objetos con propiedades predecibles. Sin embargo, dado que las funciones del generador pueden declararse e invocarse como métodos de instancia, no las considero clases.