[liblouis-liblouisxml] [liblouis] r735 committed - doc/liblouis.texi: attempt to improve harness json format section name...
- From: liblouis@xxxxxxxxxxxxxx
- To: liblouis-liblouisxml@xxxxxxxxxxxxx
- Date: Tue, 17 Jul 2012 08:54:38 +0000
Revision: 735
Author: mesar.hameed@xxxxxxxxx
Date: Tue Jul 17 01:54:17 2012
Log: doc/liblouis.texi: attempt to improve harness json format section
names.
http://code.google.com/p/liblouis/source/detail?r=735
Modified:
/trunk/doc/liblouis.texi
=======================================
--- /trunk/doc/liblouis.texi Tue Jul 17 01:32:44 2012
+++ /trunk/doc/liblouis.texi Tue Jul 17 01:54:17 2012
@@ -1810,21 +1810,21 @@
@item tables
A list containing table names, which the tests should be run against.
This is usually just one table, but for some situations more than one
table is required.
-@item sections
+@item tests
A list of sections of tests, which should be processed independantly.
-Each section is a dictionary of two items.
+Each test section is a dictionary of two items.
@item flags
-The flags that apply for all the tests in this section.
+The flags that apply for all the test cases in this section.
For example, they could all be forward translation tests, or they should
all be run as computer braille tests.
-@item tests
-The list of tests that should be run.
+@item data
+A list of test cases, each one containing the specific test data needed to
perform a test.
@end table
-These are the valid fields for the flags dictionary:
+These are the valid fields for the flags section:
@table @code
@item comment
-A field describing the reason for the test, the transformation rule or any
useful info that might be needed in case the test breaks (optional).
+A field describing the reason for the tests, the transformation rule or
any useful info that might be needed in case the test breaks (optional).
@item cursorPos
The position of the cursor within the given text (optional). Useful
when simulating screenreader interaction, to debug contraction and
@@ -1852,7 +1852,8 @@
contraction and cursor behaviour.
@end table
-Variables defined in the flags section can be overwridden by individual
tests, but if several tests need the same options, they should idealy be
split into their own section, complete with their own flags and tests.
+Variables defined in the flags section can be overwridden by individual
test cases, but if several tests need the same options, they should
+idealy be split into their own section, complete with their own flags and
data.
For examples please see @file{*_harness.txt} in the
harness directory in the source distribution.
For a description of the software, to download it and links to
project pages go to http://www.abilitiessoft.com
Other related posts:
- » [liblouis-liblouisxml] [liblouis] r735 committed - doc/liblouis.texi: attempt to improve harness json format section name... - liblouis
