Skip to content

Commit

Permalink
doc: fix rst list and block syntax
Browse files Browse the repository at this point in the history
Signed-off-by: Chase Qi <[email protected]>
  • Loading branch information
chase-qi authored and mwasilew committed Jan 25, 2019
1 parent 6b5b465 commit 6d96a9f
Showing 1 changed file with 21 additions and 21 deletions.
42 changes: 21 additions & 21 deletions automated/doc/test-writing-guidelines.rst
Original file line number Diff line number Diff line change
Expand Up @@ -55,11 +55,11 @@ Easy-to-read version of PEP 8 available at `pep8.org <http://pep8.org>`_

Use useful comments in your program to explain:

* assumptions
* important decisions
* important details
* problems you're trying to solve
* problems you're trying to overcome in your program, etc.
- assumptions
- important decisions
- important details
- problems you're trying to solve
- problems you're trying to overcome in your program, etc.

Code tells you how, comments should tell you why.

Expand Down Expand Up @@ -135,9 +135,9 @@ Example 3::
Hopefully, the above 3 examples cover most of the user cases. When
writing test cases, in general:

* Define 'SKIP_INSTALL' variable with 'false' as default.
* Add parameter '-s <True|False>', so that user can modify 'SKIP_INSTALL'.
* Try to use the above functions, and give unknown distributions more care.
- Define 'SKIP_INSTALL' variable with 'false' as default.
- Add parameter '-s <True|False>', so that user can modify 'SKIP_INSTALL'.
- Try to use the above functions, and give unknown distributions more care.

3. Saving output
~~~~~~~~~~~~~~~~~
Expand All @@ -149,7 +149,7 @@ files.
~~~~~~~~~~~~~~~~~

Saving parsed result in the same format is important for post process such as
sending to LAVA. The following result format should be followed.
sending to LAVA. The following result format should be followed::

test-caes-id pass/fail/skip
test-case-id pass/fail/skip measurement
Expand Down Expand Up @@ -274,22 +274,22 @@ Test output
At the end of the test run, the following artefact are available in the output
folder:

- `result.csv` and `result.json` which contain summary of test results
(including test name, test case ID, test results such as pass, fail, skip,
test measurement, if any, with the associated measurement unit, and the test
argument used
- For each test executed, there is a folder which contains the console output
of the test run, `stdout.log` as well as all test scripts/data
- `result.csv` and `result.json` which contain summary of test results
(including test name, test case ID, test results such as pass, fail, skip,
test measurement, if any, with the associated measurement unit, and the test
argument used
- For each test executed, there is a folder which contains the console output
of the test run, `stdout.log` as well as all test scripts/data

Test Contribution Checklist
===========================

* When applicable, check test cases with the following tools with line length
- When applicable, check test cases with the following tools with line length
rule relaxed.

- shellcheck: Shell script analysis tool.
- pycodestyle: check Python code against the style conventions in PEP 8.
- php: check syntax with 'php -l file'.
- shellcheck: Shell script analysis tool.
- pycodestyle: check Python code against the style conventions in PEP 8.
- php: check syntax with 'php -l file'.

* Run test cases on local system without LAVA.
* Optionally, run test cases in LAVA and provide job example.
- Run test cases on local system without LAVA.
- Optionally, run test cases in LAVA and provide job example.

0 comments on commit 6d96a9f

Please sign in to comment.