Affichage de la documentation de la fonction dans PyDev

Question

J'ai mis Pydev en service et presque tout fonctionne correctement. Cependant, j'ai des problèmes avec docstrings.

Disons que, par exemple, j'ai une fonction telle que:

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 

Supposons que j'ai surchargé rééd pour formater cette chaîne correctement aussi bien. Lorsque je survole cela dans Eclipse, il me montre la docstring complète comme prévu. Cependant, l'implémentation complète est également affichée sous le doctsting.

Existe-t-il un moyen de seulement afficher la docstring?

Answer 1

Ne ressemble pas actuellement. Googlé autour de cette question et le meilleur résultat m'a fait remarquer à ce Pydev-users post:

Le Lundi 3 mai 2010 à 05h45, Janosch Peters a écrit:

Salut,

lorsque je survole une fonction ou une classe, j'obtiens une info-bulle montrant la définition complète de la fonction/classe non seulement la docstring (comme je l'espère ).

Est-ce que ce comportement est attendu? Je pense que ce serait plus utile, si seulement le contenu de la docstring est montré.

C'est actuellement prévu. S'il vous plaît entrer une demande de fonctionnalité pour faire montrant juste l'option docstring.

Cheers,

Fabio

regarda autour du bug Pydev/fonctionnalité suivi et n'a pas trouvé ce problème spécifique est entré. Vous voudrez peut-être l'entrer dans le tracker de demande de fonctionnalité Pydev et voir si vous pouvez obtenir de l'aide là-bas.

Answer 2

J'ai soumis une demande de fonctionnalité dans le PyDev bug tracker, avec ID 863.

En PyCharm quand je passe la souris sur un nom de méthode, je peux voir une fenêtre montrant seule la docstring de chaque méthode, sans mise en œuvre détails. Et, comme les balises @param xx:, @rtype, etc., sont correctement analysés et présentés dans un format lisible dans le menu contextuel et style différent comme spinx/epytext/google/plain peut être modifié dans les paramètres afin qu'il puisse reconnaître tous les formats.

Je voudrais suggérer la même chose dans PyDev: un pop-up qui montre docstring avec des étiquettes analysables, sans les détails de mise en œuvre, et si comme javadoc, on peut utiliser <code>some code</code> pour le rendre comme en HTML, mieux.

Envisagez de voter jusqu'à ce billet si vous le souhaitez également. (Et peut-être voter ici aussi)