Merge pull request #84 from PhilippSalvisberg/docu_for_1.1.0

Update Documentation for version 1.1.0
utPLSQL · Aug 22, 2019 · 340bc82 · 340bc82
2 parents 28f78a7 + f3c3971
commit 340bc82
Show file tree

Hide file tree

Showing 7 changed files with 20 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -7,6 +7,7 @@ utPLSQL for SQL Developer extends Oracle's SQL Developer to
 * run existing utPLSQL unit tests
 * run utPLSQL code coverage reports 
 * generate new utPLSQL unit tests (skeletons)
+* provide utPLSQL annotations and expectations as snippets
 
 ### Run utPLSQL test
 
@@ -44,6 +45,24 @@ Select a package, type, function or procedure to build a utPLSQL test package sk
 
 ![Generate utPLSQL test](images/generate_utplsql_test_from_template.png)
 
+### Snippets
+
+Import utPLSQL snippets for annotations and expectations via the the `Import Snippets` button of the utPLSQL [preferences dialog](#preferences).
+
+Insert the snippets by drag & drop into your code.
+
+#### Annotations
+
+Annotations are used in the package specification for various test configurations.
+
+![utPLSQL Annotations](images/snippets_annotations.png)
+
+#### Expectations
+
+Expectations are used in the package body to compare actual with expected results.
+
+![utPLSQL Expectations](images/snippets_expectations.png)
+
 ### Preferences
 
 Set your preferences to change the behaviour of utPLSQL within SQL Developer.

diff --git a/images/install_utplsql.png b/images/install_utplsql.png
diff --git a/images/preferences.png b/images/preferences.png
diff --git a/images/run_utplsql_test.png b/images/run_utplsql_test.png
diff --git a/images/snippets_annotations.png b/images/snippets_annotations.png
diff --git a/images/snippets_expectations.png b/images/snippets_expectations.png
diff --git a/sqldev/pom.xml b/sqldev/pom.xml
@@ -5,7 +5,7 @@
 	<!-- The Basics -->
 	<groupId>org.utplsql</groupId>
 	<artifactId>org.utplsql.sqldev</artifactId>
-	<version>1.1.0-SNAPSHOT</version>
+	<version>1.1.0</version>
 	<packaging>bundle</packaging>
 	<properties>
 		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>