[Re2o] Choix de la syntaxe des docstrings

Coucou :) J'ai pas encore rédigé le CR de la réunion d'hier pour ceux que ça intéresse, ça va venir sous peu. En attendant, on y a soulever la question de comment écrire les docstrings et surtout quelle syntaxe adopter, mais sans avoir vraiment de réponse. C'est pourquoi je viens vous demander votre avis. Pour info en python, une docstring c'est un commentaire en début de fonction, de classe ou de module qui sert à décrire son utilité, ses paramètres, ses valeurs de retours, ... Et il existe des outils (comme "sphinx" qui est probablement ce qu'on va utiliser) pour générer de la doc à partir de ces docstrings pour peu qu'on respecte une certaine syntaxe (à peu près tout ce qu'on trouve comme doc python vient de ce genre d'outil). Il existe plusieurs syntaxes possibles et courament utilisées. Un exemple de ce que ça peut donner: https://stackoverflow.com/a/24385103 Actuellement on a une partie des docstrings qui sont au format "reST", une partie au format "Google" et une (grosse) partie qui n'a pas de syntaxe particulière. L'objectif est d'homogénéiser tout ça en adoptant une syntaxe précise, ce qui permettra aussi de générer de la doc automatiquement. Les infos sont les mêmes d'une syntaxe à l'autre juste présentées différement, ce qui veut dire que tous les outils supportent toutes les syntaxes courantes et on peut faire la même chose quelque soit la syntaxe utilisée. Au final le choix se résume surtout à une préférence de style et de présentation du code. Pour faire part de votre préference, c'est là: https://planner.rezometz.org/9Tce2dKWXw6Hpj4t Merchi ^^ Maël 'MoaMoaK' Kervella