question doctsrings : Epytext ou ReSt ?

Document Actions
Réponses: 1   Visites: 0
Up one level
Vous devez être un membre enregistré pour contribuer sur ce forum. Inscrivez-vous maintenant

question doctsrings : Epytext ou ReSt ?

Posté par miniwark le 13/05/2007 16:58
Bonjour a tous,

Pour mon premier message je voudrais votre avis sur les convention de codage de la documentation.
En effet après avoir testé mon premier scrip d'apprentissage avec PyLint ce dernier me signale les points suivants :

code:
docstrings ............. 100  (found 6/6=100.00% objects with docstrings)
formatted_docstrings ...   0  (found 0/6=0.00% objects with formatted docstrings)


J'ai donc suffisament documenté mon code, mais apparemment ma documentation n'est pas formatée.

Après quelques navigation je suis tombé sur les deux convention de formatage : reStructuredText et Epytext
* Apparemment reStructuredText est ce qui est proposé comme plus ou moins futur standard (PEP 287)
* Quand à lui Epytext me semble un poil plus lisible

Pour le moment je suis donc tenté par Epytext mais voulant au moins apprendre le futur "standand" reStructuredText
j'aimerais avoir la traduction de l'exemple suivant dans ce format :
http://epydoc.sourceforge.net/manual-epytext.html

En particulier comment décrire proprement les paramètres d'une fonction en reStructuredText ? J'ai eu beau lire la doc de reStructuredText mais je n'y ai pas vraiment trouvé d'équivalent de cet exemple.

Re: doctsrings : Epytext ou ReSt ?

Posté par miniwark le 13/05/2007 17:22
Oups ma fourche à langué. Le rapport de test cité a été fournit par Cheesecake et non PyLint.

Python.org : Le site officiel du langage Python.
Zope.org : Le site web officiel de Zope.
Daily Python-URL : Actus de l'univers Python.
Tribute to Zyons : Zyons notre ami et membre fondateur de l'Afpy, nous quittait en 2005.