diff options
| author | Théo de la Hogue | 2023-06-07 14:34:14 +0200 |
|---|---|---|
| committer | Théo de la Hogue | 2023-06-07 14:34:14 +0200 |
| commit | c4552e04e1271a9210a934233beae5be1943d034 (patch) | |
| tree | a44041e544bc700976237bfea9058ec06f9a2904 /docs/contributor_guide | |
| parent | bd9cd27c9d44c072164f564ffffeb22e37106b89 (diff) | |
| download | argaze-c4552e04e1271a9210a934233beae5be1943d034.zip argaze-c4552e04e1271a9210a934233beae5be1943d034.tar.gz argaze-c4552e04e1271a9210a934233beae5be1943d034.tar.bz2 argaze-c4552e04e1271a9210a934233beae5be1943d034.tar.xz | |
Writing User guide and use cases section.
Diffstat (limited to 'docs/contributor_guide')
| -rw-r--r-- | docs/contributor_guide/build_documentation.md | 2 | ||||
| -rw-r--r-- | docs/contributor_guide/unitary_test.md | 5 |
2 files changed, 3 insertions, 4 deletions
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: |