Comments on: Les docstrings en Python http://sametmax.com/les-docstrings/ Du code, du cul Sat, 07 Nov 2015 11:08:18 +0000 hourly 1 http://wordpress.org/?v=4.1 By: Sam http://sametmax.com/les-docstrings/#comment-48375 Tue, 10 Jun 2014 16:10:29 +0000 http://sametmax.com/?p=570#comment-48375 Oui, et la docstring prend précédence si elle est écrite. Je suppose que c’est pour permettre la compatibilité avec les outils de génération de docs qui, dans les autres langages, attendent la doc au dessus des fonctions sous forme de comment.

]]> By: herison http://sametmax.com/les-docstrings/#comment-48194 Tue, 10 Jun 2014 14:16:28 +0000 http://sametmax.com/?p=570#comment-48194 Je déterre pour partager un truc bizard, si on met des commentaires avant une class ou function, ils montent comme une docstring.

un_module.py
————
# comment on foo
# again comment
def foo():
pass

import un_module
help(un_module.foo)
foo()
# comment on foo
# again comment

Je trouve ça très laid.

]]> By: Luigi http://sametmax.com/les-docstrings/#comment-8884 Wed, 15 May 2013 11:26:14 +0000 http://sametmax.com/?p=570#comment-8884 Plutôt que de passer des heures sur le web à chercher les conventions, un petit tour sur S&M et c’est du tout cuit.

Encore merci les gars !

]]> By: Sam http://sametmax.com/les-docstrings/#comment-6774 Sat, 09 Mar 2013 09:24:57 +0000 http://sametmax.com/?p=570#comment-6774 La description générale, c’est au niveau du module.

Dans la description de la classe, tu trouveras des instructions spécifiques à la classe.

Mais on est pas en java, en Python y a pas forcément une classe par module. Je dirais même qu’architecturalement, c’est pas idéal de tout mettre dans une seule classe.

]]> By: Réchèr http://sametmax.com/les-docstrings/#comment-6769 Sat, 09 Mar 2013 08:20:32 +0000 http://sametmax.com/?p=570#comment-6769 Pas compris le dernier commentaire de Max. Par conséquent, je requiers un tampon kamoulox.

Dans la plupart des cas, on a un module, avec une seule classe dedans. La description générale de ce que ça fait, il vaut mieux la mettre dans une docstring au niveau module, ou au niveau classe ?

(J’ai lu en diagonale le PEP256, je n’ai pas trouvé de convention à ce sujet.)

]]> By: Max http://sametmax.com/les-docstrings/#comment-6720 Thu, 07 Mar 2013 13:33:02 +0000 http://sametmax.com/?p=570#comment-6720 allez-y madame la machine…allez-y

]]> By: kontre http://sametmax.com/les-docstrings/#comment-6714 Thu, 07 Mar 2013 10:03:19 +0000 http://sametmax.com/?p=570#comment-6714 Après test, le :Example: n’est pas une commande spéciale dans sphinx, on peut mettre n’importe quoi entre :: et ça fait une section.
Le .. todo:: n’est pas actif par défaut dans sphinx, d’ailleurs, ça rejoint ton avis ! ;) Perso je l’utilise quand même parce que je fais surtout de la doc pour dev.

]]> By: Sam http://sametmax.com/les-docstrings/#comment-6713 Thu, 07 Mar 2013 09:38:12 +0000 http://sametmax.com/?p=570#comment-6713 Mon enfance vient d’être violée.

]]> By: Recher http://sametmax.com/les-docstrings/#comment-6711 Thu, 07 Mar 2013 07:59:52 +0000 http://sametmax.com/?p=570#comment-6711 Wouah, je savais pas qu’il y avait toutes ces conventions et syntaxes dans les docstrings.

Pour vous remercier, voici une Olive Oil, qui sera certainement ravie d’aider à effectuer le todo sus-mentionné.

]]> By: Sam http://sametmax.com/les-docstrings/#comment-6707 Wed, 06 Mar 2013 23:05:32 +0000 http://sametmax.com/?p=570#comment-6707 @Etienne : au final, c’est toujours la faute de Max. C’est son rôle dans l’équipe.

]]>