Skip to content

Commit 1a5f450

Browse files
committed
Improved readme.md
1 parent 9ca39e9 commit 1a5f450

File tree

1 file changed

+25
-9
lines changed

1 file changed

+25
-9
lines changed

README.md

Lines changed: 25 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,11 @@ PythonTest runs python tests and shows the output in an output panel. In the pan
2020

2121
Tests may be run individually or in groups.
2222

23-
To run individual tests, in a python unit test module, put a caret in some tests and press "ctrl-c,." to run them. Every test method (or test function) containing a caret point will be run, and only those.
23+
To run individual tests, in a python unit test module, put a caret in some tests and press <kbd>Ctrl</kbd>-<kbd>c</kbd>,<kbd>.</kbd> to run them. Every test method (or test function) containing a caret point will be run, and only those.
2424

25-
To run all of the tests in a module, ensure the caret is outside of any test method or function and press "ctrl-c,."
25+
To run all of the tests in a module, ensure the caret is outside of any test method or function and press <kbd>Ctrl</kbd>-<kbd>c</kbd>,<kbd>.</kbd>
2626

27-
To run all of the tests in a project, press "ctrl-c,t" while viewing any python source file.
27+
To run all of the tests in a project, press <kbd>Ctrl</kbd>-<kbd>c</kbd>,<kbd>t</kbd> while viewing any python source file.
2828

2929
Settings
3030
--------
@@ -33,16 +33,32 @@ In the global section of a project file, PythonTest respects the `python_interpr
3333

3434
You can customize the plugin's behavior by adding a `python_test` section to a project file. In that section, the following settings may be specified:
3535

36-
*`command`: "nose2" (default) or the name of or path to a test comman. The test command is executed in a shell, so it may include arguments, for instance `python ./manage.py test` is a valid `command` setting.
36+
* `command`: "nose2" (default) or the name of or path to a test comman. The test command is executed in a shell, so it may include arguments, for instance `python ./manage.py test` is a valid `command` setting.
3737

38-
*`ignore_interpreter`: False (default). Set to True to ignore the `python_interpreter`
38+
* `ignore_interpreter`: False (default). Set to True to ignore the `python_interpreter`
3939
setting.
4040

41-
*`working_dir`: project root (default) or the path to the directory where test commands should be executed
41+
* `working_dir`: project root (default) or the path to the directory where test commands should be executed
4242

43-
*`quiet`: True (default) to hide test command details in output
43+
* `quiet`: True (default) to hide test command details in output
4444

45-
*`color_scheme`: "light" (default) or "dark" or a `.tmTheme` or `.hidden-tmTheme` filename
45+
* `color_scheme`: "light" (default) or "dark" or a `.tmTheme` or `.hidden-tmTheme` filename
4646

47-
*`syntax`: "unittest" (default) or Specify a `.tmLanguage` file to set the syntax highlighting language for test output
47+
* `syntax`: "unittest" (default) or Specify a `.tmLanguage` file to set the syntax highlighting language for test output
4848

49+
### Project settings example
50+
51+
```json
52+
{
53+
"folders":[
54+
{
55+
"path":"/home/my_user/my_project/"
56+
}
57+
],
58+
"settings":{
59+
"python_test":{
60+
"command":"python ./manage.py test"
61+
}
62+
}
63+
}
64+
```

0 commit comments

Comments
 (0)