Improve documentation in test/run.py

This commit is contained in:
Daniel Hahler
2016-11-04 14:28:27 +01:00
parent 7a347898dd
commit a4aabc2b65

View File

@@ -25,10 +25,10 @@ multiple Python versions.
.. _tox: http://testrun.org/tox .. _tox: http://testrun.org/tox
Integration test cases are located in ``test/completion`` directory Integration test cases are located in ``test/completion`` directory
and each test cases are indicated by the comment ``#?`` (completions / and each test case is indicated by either the comment ``#?`` (completions /
definitions), ``#!`` (assignments) and ``#<`` (usages). There is also definitions), ``#!`` (assignments), or ``#<`` (usages).
support for third party libraries. In a normal test run they are not There is also support for third party libraries. In a normal test run they are
being executed, you have to provide a ``--thirdparty`` option. not being executed, you have to provide a ``--thirdparty`` option.
In addition to standard `-k` and `-m` options in py.test, you can use In addition to standard `-k` and `-m` options in py.test, you can use
`-T` (`--test-files`) option to specify integration test cases to run. `-T` (`--test-files`) option to specify integration test cases to run.
@@ -64,7 +64,7 @@ happening.
Auto-Completion Auto-Completion
+++++++++++++++ +++++++++++++++
Uses comments to specify a test in the next line. The comment says, which Uses comments to specify a test in the next line. The comment says which
results are expected. The comment always begins with `#?`. The last row results are expected. The comment always begins with `#?`. The last row
symbolizes the cursor. symbolizes the cursor.
@@ -94,8 +94,8 @@ Tests look like this::
#! ['abc=1'] #! ['abc=1']
abc abc
Additionally it is possible to add a number which describes to position of Additionally it is possible to specify the column by adding a number, which
the test (otherwise it's just end of line):: describes the position of the test (otherwise it's just the end of line)::
#! 2 ['abc=1'] #! 2 ['abc=1']
abc abc