Comments on: Les docstrings en Python http://sametmax.com/les-docstrings/ Du code, du cul Mon, 28 Oct 2019 11:54:55 +0000 hourly 1 https://wordpress.org/?v=4.9.7 By: Siltaar http://sametmax.com/les-docstrings/#comment-186850 Wed, 19 Apr 2017 15:39:13 +0000 http://sametmax.com/?p=570#comment-186850 Il n’est jamais trop tard : « Ceci est une doctring écrite en unicode, sans interprétation des caractères »

En fait « Ceci est une docstring … » (avec un ‘s’ en plus donc)

]]> By: Sam http://sametmax.com/les-docstrings/#comment-183149 Tue, 29 Nov 2016 17:01:47 +0000 http://sametmax.com/?p=570#comment-183149 Merci

]]> By: Luigi http://sametmax.com/les-docstrings/#comment-182989 Thu, 24 Nov 2016 10:27:05 +0000 http://sametmax.com/?p=570#comment-182989 Petite correction :

.. warnings::

ne prend pas de S

.. warning::

]]> 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.

]]>