From 53d3ed9fa1e7631d516b6e515005f8daaff86919 Mon Sep 17 00:00:00 2001 From: David De Sloovere Date: Mon, 1 Oct 2018 15:28:41 +0200 Subject: [PATCH] Add virtual environment info to testing (tox) doc (#98) * Update testing info with virtual environment Being new to python, pip and virtual environments, I tried running `tox` without activating the virtual environment. This should make it a little bit more clear for newcomers. * Update development_testing.md * Update development_testing.md * Update development_testing.md --- docs/development_testing.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/docs/development_testing.md b/docs/development_testing.md index fbca68be..79793400 100644 --- a/docs/development_testing.md +++ b/docs/development_testing.md @@ -2,7 +2,12 @@ title: "Testing your code" --- -As states in the [Style guidelines section](development_guidelines.md) all code is checked to verify all unit tests pass and that the code passes the linting tools. Local testing is done using Tox, which has been installed as part of running `script/setup`. To start the tests, simply run it: +As it states in the [Style guidelines section](development_guidelines.md) all code is checked to verify the following: + +- All the unit tests pass +- All code passes the checks from the linting tools + +Local testing is done using Tox, which has been installed as part of running `script/setup` in the [virtual environment](development_environment.md). To start the tests, activate the virtual environment and simply run the command: ```bash $ tox