From c4552e04e1271a9210a934233beae5be1943d034 Mon Sep 17 00:00:00 2001 From: Théo de la Hogue Date: Wed, 7 Jun 2023 14:34:14 +0200 Subject: Writing User guide and use cases section. --- docs/contributor_guide/build_documentation.md | 2 +- docs/contributor_guide/unitary_test.md | 5 ++--- 2 files changed, 3 insertions(+), 4 deletions(-) (limited to 'docs/contributor_guide') diff --git a/docs/contributor_guide/build_documentation.md b/docs/contributor_guide/build_documentation.md index 20df1df..b8fe7e3 100644 --- a/docs/contributor_guide/build_documentation.md +++ b/docs/contributor_guide/build_documentation.md @@ -5,7 +5,7 @@ ArGaze has a standard MkDocs layout which is built by Read the Docs. You can bui !!! note - *Consider that all inline commands below have to be executed into ArGaze root folder.* + *Consider that all inline commands below have to be executed at the root of ArGaze package folder.* Install required Python dependencies (MkDocs etc.): ```console diff --git a/docs/contributor_guide/unitary_test.md b/docs/contributor_guide/unitary_test.md index 42cf24c..36010bf 100644 --- a/docs/contributor_guide/unitary_test.md +++ b/docs/contributor_guide/unitary_test.md @@ -1,12 +1,11 @@ Unitary test ============ -ArGaze package unitary tests are based on [unittest](https://docs.python.org/fr/3.10/library/unittest.html) module. -Test files tree structure is mirroring the file tree structure of src/argaze folder. +ArGaze package unitary tests are based on [unittest](https://docs.python.org/fr/3.10/library/unittest.html) module. Test files tree structure is mirroring the file tree structure of src/argaze folder. !!! note - *Consider that all inline commands below have to be executed into ArGaze root folder.* + *Consider that all inline commands below have to be executed at the root of ArGaze package folder.* To run all unitary tests: -- cgit v1.1