Différences

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

--- dev:python:documentation_du_code [2022/12/30 09:10] – Ajout liens références yoann
+++ dev:python:documentation_du_code [2023/01/03 23:29] (Version actuelle) – yoann
@@ Ligne 19: / Ligne 19: @@
   * La description brève
   * Un saut de ligne
-  * Le developpement de la docstring
+  * Le développement de la docstring
   * Une ligne vide
@@ Ligne 32: / Ligne 32: @@
 </code>
-Des formatages particuliers peuvent être utilisés dans la donctring. Cela être interprété par des outils tiers (doctring parsers) comme **reStructuredText**
+Des formatages particuliers peuvent être utilisés au sein de la doctring comme **reStructuredText**. Ils sont ensuite exploités par des outils tiers comme **Sphinx** pour générer de la documentation sous différents dormat (html, man etc) ou vérifier le code.
-Ci-dessous  un exemple de docstring formatée pour reStructuredText
+Ci-dessous  un exemple de docstring formatée avec reStructuredText
 <code python>
 """Gets and prints the spreadsheet's header columns
@@ Ligne 47: / Ligne 47: @@
 :rtype: list
 """
 </code>
 ===== Références =====
@@ Ligne 56: / Ligne 57: @@
   * https://sphinx-tutorial.readthedocs.io/step-1/
   * https://docutils.sourceforge.io/rst.html#user-documentation
+  * https://thomas-cokelaer.info/tutorials/sphinx/rest_syntax.html
+  * https://www.devdungeon.com/content/restructuredtext-rst-tutorial-0
+  * https://www.datacamp.com/tutorial/docstrings-python
+  * https://gist.github.com/jesugmz/d83b5e9de7ccc16f71c02adf7d2f3f44

wikinotes

Outils pour utilisateurs

Outils du site

Différences

Outils de la page