Feature doc change generating text (#218)

* wip

* wip

* wip

* updated running of prospector

Author: ronanstokes-db

docs/source/textdata.rst

@@ -118,6 +118,12 @@ Here are some examples of its use to generate dummy email addresses, ip addresse
 
 The implementation of the template expansion uses the underlying `TemplateGenerator` class.
 
+.. note ::
+   The ``template`` option is shorthand for ``text=dg.TemplateGenerator(template=...)``
+
+   This can be specified in multiple modes - see the `TemplateGenerator` documentation for more details.
+
+
 TemplateGenerator options
 ---------------------------------------------
 
@@ -162,6 +168,9 @@ It uses the following special chars:
 
           The ``escapeSpecialChars`` is set to False by default for backwards compatibility.
 
+          To use the ``escapeSpecialChars`` option, use the variant
+          ``text=dg.TemplateGenerator(template=...), escapeSpecialChars=True``
+
 In all other cases, the char itself is used.
 
 The setting of the ``escapeSpecialChars`` determines how templates generate data.

makefile

@@ -89,11 +89,13 @@ dev-test:
 
 dev-lint-report:
 	@echo "$(OK_COLOR)=> Running Prospector lint reporting $(PWD) $(NO_COLOR)"
-	prospector --profile prospector.yaml > prospector_report.txt
+	prospector --profile prospector.yaml dbldatagen > prospector_report.txt
+	prospector --profile prospector.yaml tests >> prospector_report.txt
 
 dev-lint:
 	@echo "$(OK_COLOR)=> Running Prospector lint reporting $(PWD) $(NO_COLOR)"
-	prospector --profile prospector.yaml
+	prospector --profile prospector.yaml dbldatagen
+	prospector --profile prospector.yaml tests
 
 dev-test-with-html-report:
 	@echo "$(OK_COLOR)=> Running unit tests with HTML test coverage report$(NO_COLOR)"