Différences

Ci-dessous, les différences entre deux révisions de la page.

--- fr:py_nel [2017/08/25 09:17] – Typo osquallo
+++ fr:py_nel [2021/12/03 18:19] (Version actuelle) – modification externe 127.0.0.1
@@ Ligne 12: / Ligne 12: @@
 Une fois fait on devrai pouvoir faire un merge sur master et avoir une première version suffisamment stable et robuste pour pouvoir la "publier" et proposer quelque chose qui ne devrai pas changé trop rapidement en dehors d’éventuel hotfix et correctifs mineurs.
+Et donc commencer a créer la doc sur ce wiki.
 Un scoui
@@ Ligne 48: / Ligne 50: @@
 Je crée cette page ne serai-ce que pour pouvoir commencer à la remplir et parce que je risque de bientôt rendre "public" le fait que je taff la dessus, vu que ça avance quand même assez vite.
 osquallo
+==== Documentation pour les devs ====
+=== Intro ===
+Le code suis (dans la mesure de mes propres connaissances sur le sujet et avec peut être de légère variation dans certains cas, sachant que visiblement le pep suis généralement ma propre façon de faire (vu que j'ai quelque année d'avance sur certains points semble t-il), les recommendation du PEP dans le but d’être plus facilement lu par diverses personne d'horizon différent.
+Cela dit la seul règle vraiment importante reste la lisibilité quitte sur un cas particulier à s'adapter a la situation et  jamais a adapter le code pour le forcer à suivre des regles lorsque celle ci ne s'avere plus adapter a la situation, faites surtout en sorte que cela soit lisible et oublier votre ego/fierté, préférer utiliser votre cervelle et réfléchissez à ce que vous faites.
+La citation python qui me semble la plus importante est:
+Explicit over implicit
+Exemple: Préférer utiliser des noms explicites même si cela les rallongent un peu plutôt que d'utiliser des nom flou et aisément interprétable de diverses façon ou nécessitant une doc rien que pour les expliquer, et éviter les acronymes pour les méthodes/fonctions ! Même si ils vous semblent évident, cela dois rester une solution de dernier recours, évitez que cela soit systématique ou le choix par défaut.
+Si vous vous connaissez votre code les autre non, de plus vous même ne le connaitrez plus après plusieurs mois sans y toucher donc penser a non seulement aux autres mais aussi a vous même plus tard.
+Aérer le code, on ne dois pas avoir mal au crane rien qu'en le regardant.
+=== liens utiles ===
+[[https://www.python.org/dev/peps/pep-0008/|PEP8 Style Guide for Python Code]]
+[[https://www.python.org/dev/peps/pep-0257/|PEP257 Docstring Conventions]]
+[[https://www.python.org/dev/peps/pep-0224/|PEP224 Attribute Docstrings]]
 {{tag>Tag_a_ajouter}}