python - tutorial - Visualización de la documentación de la función en PyDev

pydev eclipse tutorial

Question

Puse a Pydev en funcionamiento y casi todo está funcionando bien. Sin embargo estoy teniendo algunos problemas con docstrings.

Digamos, por ejemplo, que tengo 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 también he reemplazado repr para formatear esa cadena correctamente.

Cuando coloco el cursor sobre esto en Eclipse, me muestra la cadena de documentación completa según lo previsto. Sin embargo, la implementación completa también se muestra debajo de la documentación.

¿Hay una manera de mostrar sólo la cadena de documentos?

Answer 1

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

En PyCharm, cuando paso sobre un nombre de método, puedo ver una ventana emergente que muestra solo la cadena de documentos de cada método, sin detalles de implementación. Y, las etiquetas como @param xx: @rtype , etc., se analizan correctamente y se muestran en un formato legible en la ventana emergente, y se pueden ajustar diferentes estilos como spinx / epytext / google / plain en la configuración para que pueda reconocer todos los formatos

Me gustaría sugerir lo mismo en PyDev: una ventana emergente que muestra la cadena de documentos con etiquetas analizadas, sin detalles de implementación, y si como javadoc, se puede usar <code>some code</code> para representarlo como en HTML, mejor.

Considera votar a este boleto si también quieres esto. (Y tal vez vota aquí también)

Answer 2

No se parece a eso actualmente. Busqué en Google para este problema y el resultado principal me indicó esta publicación de usuarios de Pydev :

El lunes, 3 de mayo de 2010 a las 5:45 AM, Janosch Peters escribió:

Hola,

cuando paso sobre una función o clase, obtengo una información sobre herramientas que muestra la definición completa de la función / clase, no solo la cadena de documentación (como es de esperar).

¿Es este el comportamiento esperado? Creo que sería más útil si solo se muestra el contenido de la cadena de documentos.

Actualmente se espera. Por favor ingrese una solicitud de función para hacer que se muestre solo la cadena de documentos como una opción.

Aclamaciones,

Fabio

Miró alrededor del rastreador de errores / características de Pydev y no encontró este problema específico ingresado. Es posible que desee ingresarlo en el rastreador de solicitud de características de Pydev y ver si puede obtener ayuda allí.