Amélioration de la documentation: explication des tests

doc/DOCUMENTATION.md

@@ -9,9 +9,9 @@ Pour écrire un commentaire qui apparaitra sur la doc de cargo, écrivez :
 ```rust
 /// Votre commentaire
 ```
-pour commenter votre fonction, attribut, structure....
+pour commenter votre fonction, attribut, structure, module....
 
-Pour les commentaires de **crate** et **module**, utilisez :
+Pour les commentaires de **crate**, utilisez :
 
 ```rust
 //! Votre commentaire
@@ -28,14 +28,14 @@ Petit aide avec la markdown dans le chapitre [#aide-markdown](#aide-markdown).
 
 Vous obtenez quelque chose sur votre code comme à la figure 1.
 
-![Capture d'écran de main.rs](Screenshot_20221019_153737.png "Aperçu de mon main")
+![Capture d'écran de main.rs](Screenshot_20221019_153737.png "Aperçu du main")
 
 
 ## Générer la documentation Rust
 
-Éxecutez la commande __`cargo doc`__ dans le dossier du projet, cela va générer un dossier dans le dossier **target/doc/** qui contient des pages web, ouvrez le fichier **burritos/all.html**
+Éxecutez la commande __`cargo doc`__ dans le dossier du projet, cela va générer un dossier dans le dossier **target/doc/** qui contient des pages web, ouvrez le fichier **target/doc/burritos/all.html**.
 
-Lors de l'affichage de la liste de vos fonctions et autres éléments, la doc n'affiche que la première ligne, le autres lignes sont affiché lorsqu'on ouvre les détails.
+Lors de l'affichage de la liste de vos fonctions et autres éléments, la doc **n'affiche que la première ligne**, le autres lignes sont affiché lorsqu'on ouvre les détails.
 
 ### Exemple
 
@@ -168,18 +168,22 @@ ligne
 
 ```md
 [Mon lien](www.google.com)
-![Mon image](www.imagelink.com)
+![Mon image sur internet](www.imagelink.com/image.png)
+![Mon image stocké sur mon pc](image/monscreenshot.png)
 ```
 
-### Autres
 
-Vous pouvez retrouver d'autres exemples par ici:
+## Faire des tests
 
-[https://doc.rust-lang.org/rustdoc/how-to-write-documentation.html](https://doc.rust-lang.org/rustdoc/how-to-write-documentation.html)
+Pour écrire vos tests faites comme dans l'exemple ci-dessous: 
 
-ou ici
+![Exemple de test](Screenshot_20221019_173551.png)
 
-[https://www.markdownguide.org/cheat-sheet/](https://www.markdownguide.org/cheat-sheet/) -- Méga utile
+Executez ensuite les tests en faisant `cargo test`, vous obtenez comme en suivant l'exemple ci-dessus le résultat de la figure 5.
+
+![Exemple de résultat des tests](Screenshot_20221019_174036.png)
+
+Lors d'un cargo build optimisé (`cargo build --release`), les tests ne sont pas inclus dans le fichier binaire.
 
 ## Liens utiles
 
@@ -189,3 +193,4 @@ La documentation officielle du crate std: [https://doc.rust-lang.org/std/index.h
 
 La documentation des crates téléchargeable sur [https://crates.io/](https://crates.io/) est retrouvable sur: [https://docs.rs/](https://docs.rs/)
 
+Pour le markdown vous pouvez retrouver des tutos ici: [https://doc.rust-lang.org/rustdoc/how-to-write-documentation.html](https://doc.rust-lang.org/rustdoc/how-to-write-documentation.html) et ici [https://www.markdownguide.org/cheat-sheet/](https://www.markdownguide.org/cheat-sheet/)