Documentation Updates

DDieterich · DDieterich · commit 15561773bd77 · 2018-06-14T04:41:36.000-05:00
diff --git a/docs/Best-Practices.md b/docs/Best-Practices.md
@@ -53,5 +53,7 @@ $END  ----------------%WTPLSQL_end_ignore_lines%----------------
    --------------------------------------  WTPLSQL Testing --
 ```
 
+**Check and/or set NLS settings before testing.** Many data types are implicitly converted to VARCHAR2 before comparison. The "wtplsql" package includes functions to check and set NLS settings. Note: Modifying these settings always includes a COMMIT.
+
 ---
 [Website Home Page](README.md)
diff --git a/docs/README.md b/docs/README.md
@@ -92,6 +92,7 @@ More information is available [in this link](utPLSQL-V2-Comparison).
 * [Other Definitions](Other-Definitions.md)
 * [utPLSQL V3 Comparison](utPLSQL-V3-Comparison)
 * [utPLSQL V1/V2 Comparison](utPLSQL-V2-Comparison)
+* [Reference](Reference.md)
 * [Latest wtPSQL DB Docs](core/DBDocs/index.html)
 * [ER Diagram PDF](core/ER_Diagrams.pdf)
 * [Call Tree Diagrams PDF](core/Call_Tree_Diagrams.pdf)
diff --git a/docs/Reference.md b/docs/Reference.md
@@ -0,0 +1,39 @@
+[Website Home Page](README.md)
+
+# Reference
+
+---
+## Datatypes Supported
+Oracle Data Type Families<br>
+https://docs.oracle.com/cd/E11882_01/appdev.112/e25519/predefined.htm#LNPLS2047
+
+* VARCHAR2 - Includes ROWID, LONG*, RAW, LONG RAW*, and NVARCHAR2
+* DATE** - Includes TIMESTAMP and INTERVAL
+* NUMBER** - Includes PLS_INTEGER
+* BOOLEAN
+* XMLTYPE
+* CLOB - Includes NCLOB
+* BLOB
+
+*LONG and LONG RAW data length is limited to VARCHAR2 length in PL/SQL (32K).<br>
+**VARCHAR2 includes DATE and NUMBER using Implicit Data Conversions:<br>
+https://docs.oracle.com/cd/E11882_01/server.112/e41084/sql_elements002.htm#i163326
+
+Many data types are converted to VARCHAR2 before comparison. This ensures most results are captured and reported exactly as they were tested.
+
+There is a balance to strike between simplicity and localization. Many data types must be converted to "strings" before display. Converting a data type at the time it is displayed can lead to confusing results. Since each assertion includes the capture of the values that were compared, the values that are captured are the actual values tested.
+
+An obvious drawback of this approach is running assertions when NLS settings must be set to something other than the setting that is needed for comparison. In this case, an explicit conversion can be made in the Test Runnner using the needed format.
+
+## Custom Error Codes
+* ORA-20001 - WTPLSQL Package: RUNNER_NAME is NULL
+* ORA-20002 - WTPLSQL Package: RUNNER_NAME (name) is not valid
+* ORA-20003 - WT_ASSERT Package: User Test Result is FAIL (g_raise_exception is TRUE)
+* ORA-20004 - WT_PROFILER Package: in_test_run_id is NULL
+* ORA-20005 - WT_PROFILER Package: dbms_profiler.INTERNAL_VERSION_CHECK returned (error)
+* ORA-20006 - WT_PROFILER Package: dbms_profiler.START_PROFILER returned (error)
+* ORA-20009 - WT_RESULT Package: "in_test_run_id" cannot be NULL
+* ORA-20010 - WT_TEST_RUN_STAT Package: Unknown Result status
+* ORA-20011 - WT_TEST_RUN_STAT Package: Unknown Profile status
+---
+[Website Home Page](README.md)
diff --git a/docs/demo/README.md b/docs/demo/README.md
@@ -1,11 +1,10 @@
 # Demonstrations and Examples
 ---
 Demonstrations and examples assume successful connection to an [Oracle database](http://www.oracle.com/technetwork/database/database-technologies/express-edition/overview/index.html) with wtPLSQL installed. [wtPLSQL Installation instructions](https://github.com/DDieterich/wtPLSQL/releases) are available on the [wtPLSQL Releases page](https://github.com/DDieterich/wtPLSQL/releases).
-All demonstration and example code is included in the web pages below?
 
 ## Simple Stuff
 
-The simplest check for the wtplsql is to select the "version from dual".
+The simplest check for a wtPLSQL installation is to select the "version from dual".
 
 Run this:
 ```
@@ -36,7 +35,7 @@ And get this:
 PASS Ad-Hoc Test. EQ - Expected "1" and got "1"
 ```
 
-This ad-hoc test also demonstrates implicit data type conversion, which allows a wider variety of testing. Many data types are converted to VARCHAR2 before comparison. This ensures most results are captured and reported exactly as they were tested.
+Note: This ad-hoc test also demonstrates implicit data type conversion.
 
 The majority of wtPLSQL testing uses a Test Runner. A Test Runner is a PL/SQL package written by the tester. [This page](Test-Runner.md) has an example of a very simple [Test Runner](Test-Runner.md). All the examples below will use Test Runners.
 
diff --git a/docs/demo/Test-Runner.md b/docs/demo/Test-Runner.md
@@ -35,4 +35,10 @@ end;
 /
 ```
 
- The results can be queried from those tables. Alternatively, a default reporting package called 
+The results can be queried from those tables. Alternatively, a default reporting package called 
+
+## Test Cases
+
+## Annotations
+
+Why is it necessary to scan the Test Runner source code for the DBOUT annotation?
diff --git a/src/core/README.txt b/src/core/README.txt
@@ -48,16 +48,3 @@ UnInstall Procedure:
 1) sqlplus SYS/password as SYSDBA @uninstall
 2) exit
 3) Compare uninstall.LST to uninstallO.LST
-
-
-Custom Error Codes:
--------------------
-20001 - WTPLSQL: RUNNER_NAME is NULL
-20002 - WTPLSQL: RUNNER_NAME (name) is not valid
-20003 - WT_ASSERT: User Test Result is FAIL (g_raise_exception is TRUE)
-20004 - WT_PROFILER: in_test_run_id is NULL
-20005 - WT_PROFILER: dbms_profiler.INTERNAL_VERSION_CHECK returned (error)
-20006 - WT_PROFILER: dbms_profiler.START_PROFILER returned (error)
-20009 - WT_RESULT: "in_test_run_id" cannot be NULL
-20010 - WT_TEST_RUN_STAT: Unknown Result status
-20011 - WT_TEST_RUN_STAT: Unknown Profile status
diff --git a/src/core/wt_assert.pks b/src/core/wt_assert.pks
@@ -9,7 +9,7 @@ is
 
    -- See RESET_GLOBALS procedure for default global values
 
-   -- Testcase name for a series of assetions.
+   -- Testcase name for a series of assertions.
    --   Modify as required
    g_testcase         wt_results.testcase%TYPE;
 
