Added python version information to precommit script

Signed-off-by: VinashakAnkitAman <ankit.aman@radisys.com>
magma · Apr 1, 2022 · ae1aa6c · ae1aa6c
1 parent 0b3c675
commit ae1aa6c
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git a/lte/gateway/docker/python-precommit/README.md b/lte/gateway/docker/python-precommit/README.md
@@ -26,12 +26,12 @@ cd $MAGMA/lte/gateway/python
 # to run the flake8 linter by specifying paths
 ./precommit.py --lint -p PATH1 PATH2
 # to run the flake8 linter on all modified files in the current commit
-./precommit.py --lint--diff
+./precommit.py --lint --diff
 
 # to run all available formatters by specifying paths
 ./precommit.py --format -p PATH1 PATH2
 # to run all available formatters on all modified files in the current commit
-./precommit.py --format--diff
+./precommit.py --format --diff
 ```
 
 Note: Python version >= 3.7 is needed to run the above precommit.py script

diff --git a/lte/gateway/python/precommit.py b/lte/gateway/python/precommit.py
@@ -1,4 +1,5 @@
 #!/usr/bin/env python3
+# Note: Python version >= 3.7 is needed to run this script
 """
 Copyright 2020 The Magma Authors.