docs(cz/customize): update doc for jinja support

Lee-W · Lee-W · commit d44ade8d0f78 · 2019-11-19T13:38:05.000-05:00
#54
diff --git a/docs/customization.md b/docs/customization.md
@@ -151,7 +151,7 @@ Example:
 name = "cz_customize"
 
 [tool.commitizen.customize]
-message_template = "{change_type}: {message}"
+message_template = "{{change_type}}:{% if show_message %} {{message}}{% endif %}"
 example = "feature: this feature eanable customize through config file"
 schema = "<type>: <body>"
 bump_pattern = "^(break|new|fix|hotfix)"
@@ -171,14 +171,19 @@ message = "Select the type of change you are committing"
 type = "input"
 name = "message"
 message = "Body."
+
+[[tool.commitizen.customize.questions]]
+type = "confirm"
+name = "show_message"
+message = "Do you want to add body message in commit?"
 ```
 
 ### Customize configuration
 
 | Parameter | Type | Default | Description |
 | --------- | ---- | ------- | ----------- |
 | `question` | `dict` | `None` | Questions regarding the commit message. Detatiled below. |
-| `message_template` | `str` | `None` | The template for generating message from the given answers. `message_template` should follow the python string formatting specification, and all the variables in this template should be defined in `name` in `questions`. |
+| `message_template` | `str` | `None` | The template for generating message from the given answers. `message_template` should follow the [Jinja2](https://jinja.palletsprojects.com/en/2.10.x/) formatting specification, and all the variables in this template should be defined in `name` in `questions`. |
 | `example` | `str` | `None` | (OPTIONAL) Provide an example to help understand the style. Used by `cz example`. |
 | `schema` | `str` | `None` | (OPTIONAL) Show the schema used. Used by `cz schema`. |
 | `info_path` | `str` | `None` | (OPTIONAL)  The path to the file that contains explanation of the commit rules. Used by `cz info`. If not provided `cz info`, will load `info` instead. |
diff --git a/tests/test_cz_customize.py b/tests/test_cz_customize.py
@@ -10,7 +10,6 @@ def config():
     _conf = Config()
     toml_str = r"""
     [tool.commitizen.customize]
-    # message_template should follow the python string formatting spec
     message_template = "{{change_type}}:{% if show_message %} {{message}}{% endif %}"
     example = "feature: this feature eanable customize through config file"
     schema = "<type>: <body>"
