From 606e21d1b8af10a75d193aad3eb84dd61551c77e Mon Sep 17 00:00:00 2001 From: Pavel Tisnovsky Date: Wed, 17 Jul 2019 09:38:37 +0200 Subject: [PATCH] Updated documentation --- README.md | 54 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 54 insertions(+) diff --git a/README.md b/README.md index 6308ba33..e67335e7 100644 --- a/README.md +++ b/README.md @@ -491,6 +491,60 @@ Note both jobs require [authentication](#authentication-authorization). ### Footnotes +#### Check for all possible issues + +The script named `check-all.sh` is to be used to check the sources for all detectable errors and issues. This script can be run w/o any arguments: + +``` +./check-all.sh +``` + +Expected script output: + +``` +Running all tests and checkers + Check all BASH scripts + OK + Check documentation strings in all Python source file + OK + Detect common errors in all Python source file + OK + Detect dead code in all Python source file + OK + Run Python linter for Python source file + OK + Unit tests for this project + OK +Done + +Overal result + OK +``` + +An example of script output when one error is detected: + +``` +Running all tests and checkers + Check all BASH scripts + Error: please look into files check-bashscripts.log and check-bashscripts.err for possible causes + Check documentation strings in all Python source file + OK + Detect common errors in all Python source file + OK + Detect dead code in all Python source file + OK + Run Python linter for Python source file + OK + Unit tests for this project + OK +Done + +Overal result + One error detected! +``` + +Please note that the script creates bunch of `*.log` and `*.err` files that are temporary and won't be commited into the project repository. + #### Coding standards - You can use scripts `run-linter.sh` and `check-docstyle.sh` to check if the code follows [PEP 8](https://www.python.org/dev/peps/pep-0008/) and [PEP 257](https://www.python.org/dev/peps/pep-0257/) coding standards. These scripts can be run w/o any arguments: