From d33bac281bcf5a89814606d26df118b5ca45a6e5 Mon Sep 17 00:00:00 2001 From: Rajiv Ranjan Singh Date: Mon, 24 Feb 2020 19:16:11 +0530 Subject: [PATCH 1/2] improved README.md --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index efa2646ee..8178e66e6 100644 --- a/README.md +++ b/README.md @@ -30,6 +30,14 @@ python3 setup.py develop Make sure that your python version is above `3.5`. +Testing +------- + +For testing your patch locally follow the steps given below, + +1. Install [pytest-cov](https://pypi.org/project/pytest-cov/). Skip this step if you are already having the package. +2. Run, `python3 -m pytest --doctest-modules --cov=./ --cov-report=html`. Look for, `htmlcov/index.html` and open it in your browser, which will show the coverage report. Try to ensure that the coverage is not decreasing by less than 1% for your patch. + Why we use Python? ----------------- From fbaacb977632416b120fd661c25e005edfa8b916 Mon Sep 17 00:00:00 2001 From: Rajiv Ranjan Singh Date: Mon, 24 Feb 2020 19:24:33 +0530 Subject: [PATCH 2/2] corrected previous mistakes in README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 8178e66e6..2ac694e73 100644 --- a/README.md +++ b/README.md @@ -39,7 +39,7 @@ For testing your patch locally follow the steps given below, 2. Run, `python3 -m pytest --doctest-modules --cov=./ --cov-report=html`. Look for, `htmlcov/index.html` and open it in your browser, which will show the coverage report. Try to ensure that the coverage is not decreasing by less than 1% for your patch. Why we use Python? ------------------ +------------------ As we know Python is an interepreted language and hence is slow as compared to C++, the most popular language for sports programming. We still decided to use Python because the software