Viendo la documentación en función de PyDev

Question

he conseguido PyDev en funcionamiento, y casi todo está funcionando bien. Sin embargo estoy teniendo algunos problemas con las cadenas de documentación.

Vamos a decir por ejemplo que tiene una función como la siguiente:

def _get_logging_statement(self):
    """Returns an easy to read string which separates items in the log file cleanly"""
    result = "\n\n#============================================="
    result += "\n#   %-80s#"(self)
    result =+ "\n\n#============================================"
    return result

Supongamos que he repr reemplazado al formato de esa cadena correctamente también.

Cuando Pase el ratón sobre esto en Eclipse que me muestra la cadena de documentación completa como se pretende. Sin embargo, la aplicación plena también se muestra debajo de la doctsting.

¿Hay una manera de Sólo mostrar la cadena de documentación?

Answer 1

No lo parece actualmente. Buscado en Google en torno a este tema y el primer resultado me señaló a este PyDev usuarios posterior :

El lun 3 de mayo de 2010 a las 05:45 AM, Janosch Peters escribió:

Hola,

cuando Pase el ratón sobre una función o clase, me sale una información sobre herramientas que muestra el toda definición de la función / clase no sólo la cadena de documentación (como yo sería de esperar).

¿Es este comportamiento esperado? Creo que sería más útil, aunque sólo se muestra el contenido de la cadena de documentación.

Se espera actualmente. Por favor, introduzca una solicitud de función para hacer mostrando sólo la cadena de documentación es una opción.

Saludos,

Fabio

Miró a su alrededor el error PyDev / rastreador de función y no encontrar este tema específico introducido. Es posible que desee introducir en la solicitud función de rastreador PyDev y ver si puede obtener ayuda allí.

Answer 2

He presentado una solicitud de función en el PyDev seguimiento de errores , con ID 863.

En PyCharm cuando se ciernen sobre un nombre de método, puedo ver una demostración emergente Sólo la cadena de documentación de todos los métodos, sin detalles de implementación. Y, al igual que las etiquetas @param xx:, @rtype, etc., se analizan correctamente y se muestra en un formato legible en la ventana emergente, y diferente estilo como spinx / epytext / google / plain puede ser ajustado en la configuración de modo que pueda reconocer todos los formatos.

Me gustaría sugerir lo mismo en PyDev: un emergente que muestra docstring con etiquetas analiza, sin detalles de implementación, y si como javadoc, se puede utilizar <code>some code</code> para que sea igual que en HTML, mejor.

Considere votar hasta este billete si también desea esto. (Y tal vez votar hasta aquí, también)