summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authoralistairadamsqt <alistair.adams@qt.io>2017-03-14 10:31:41 -0700
committerjryannel <juergen@ryannel.org>2017-03-14 18:31:41 +0100
commit31034623acaaffbcbdac0b13654463653d8b1eca (patch)
tree288680ccb17e74ea5af01f879140e14632fad674
parente200aa185879940bbf6db7ec3fa21a1f011e3fa5 (diff)
downloadqtivi-qface-31034623acaaffbcbdac0b13654463653d8b1eca.tar.gz
Update usage.rst (#22)
* Update usage.rst * Update usage.rst * Update usage.rst
-rw-r--r--docs/usage.rst6
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/usage.rst b/docs/usage.rst
index 8cc059f..af0e06b 100644
--- a/docs/usage.rst
+++ b/docs/usage.rst
@@ -18,7 +18,7 @@ Invocation
Direct Invocation
-----------------
-You can call the generator directly by using the provided script. All generator should at minimum expect a series of inputs and one output path. This is normally recommended for production.
+You can call the generator directly by using the provided script. All generators should at minimum expect a series of inputs and one output path. This is normally recommended for production.
.. code-block:: sh
@@ -70,7 +70,7 @@ And then call the client with:
Code Generation Principle
=========================
-The code generation is driven by a small script which iterates over the domain model and writes files using a template language (see http://jinja.pocoo.org) and espcially the template designer documentation (http://jinja.pocoo.org/docs/dev/templates/).
+The code generation is driven by a small script which iterates over the domain model and writes files using the Python Jinja template language. Refer to http://jinja.pocoo.org and particularly the template designer documentation at http://jinja.pocoo.org/docs/dev/templates/.
.. code-block:: python
@@ -99,4 +99,4 @@ This script reads the input directory returns a system object form the domain mo
{% endfor -%}
{% endfor %}
-The template iterates over the domain objects and generates text which is written into a file. The file name is also adjustable using the same template language.
+The template iterates over the domain objects and generates text which is written into a file. Using the generator write method ``generator.write(path, template, context)`` the output file path can also be specified using the template syntax .