Discussion :

[marien50470]

Bonjour à vous, voilà ma question est simple comment renseigne t-on les variables globales dans les doc-strings de python pour sphinx.
Merci pour vos réponse.

[wiztricks]

Salut,

Une variable n'a pas de __doc__ pour y stocker une "doc string", mais on peut faire comme si... ou utiliser un "doc comment" ( #: ).
Voir l'exemple.

- W

[marien50470]

Salut et merci pour ta réponse ^^ .
Mais je me suis mal exprimé je pense, en fait lorsque je document ma fonction je met:

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
 
def mafonction(maVariables):
      """
          :param maVaribles: mon commentaire sur cette fonction
          :type maVariables: le type de la variable
      """

et ma question est si je dois mettre avec les balise :param et :type les variable globales ou y-a t-il une balise particuliére ?

[wiztricks]

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
 
def mafonction(maVariables):
      """
          :param maVaribles: mon commentaire sur cette fonction
          :type maVariables: le type de la variable
      """

et ma question est si je dois mettre avec les balise :param et :type les variable globales ou y-a t-il une balise particuliére ?

Est-ce qu'une variable globale est paramètre d'une fonction?
La seule chose que vous pouvez renseigner dans ce cas serait le type.... Et la syntaxe vous est donnée dans l'exemple précédent.

- W

[marien50470]

D'accord merci beaucoup ^^