Mostrar la documentación de la función en PyDev

Question

He puesto Pydev en funcionamiento y casi todo funciona bien. Sin embargo, estoy teniendo problemas con las cadenas de documentos.

Digamos, por ejemplo, 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 

asume que hemos anulado repr para dar formato a esa cadena correctamente también.

Al pasar el cursor sobre esto en Eclipse, me muestra el docstring completo como estaba previsto. Sin embargo, la implementación completa también se muestra debajo del doc.

¿Hay alguna manera de mostrar solo la carpeta de documentos?

Answer 1

No se ve como actualmente. Buscado en Google en torno a este tema y el primer resultado me señaló a este Pydev-users post:

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

Hola,

Al pasar el ratón 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 de la cadena de documentación (como I esperaría).

¿Este comportamiento es esperado? Creo que sería más útil, si solo se muestra el contenido de la docstring.

Se espera actualmente. Ingrese una solicitud de función para hacer que muestre solo la docstring una opción.

Saludos,

Fabio

miró a su alrededor el error PyDev/función de rastreador y no encontrar este tema específico entró. Es posible que desee ingresarlo en el rastreador de solicitudes de funciones de Pydev y ver si puede obtener ayuda allí.

Answer 2

he presentado una solicitud de función en el PyDev bug tracker, con ID 863.

En PyCharm cuando se ciernen sobre un nombre de método, que puede ver una ventana emergente que muestra únicamente la cadena de documentación de todos los métodos, sin la implementación detalles. 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 un estilo diferente, como spinx/epytext/Google puede ser ajustado en la configuración para que se pueda reconocer /plain todos los formatos

me gustaría sugerir lo mismo en PyDev: una ventana emergente que muestra cadena de documentación con las etiquetas analizados, 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 a esta entrada si también quiere esto. (Y tal vez vote aquí también)