Skip to content

Commit 0286e7b

Browse files
committed
docs(cz/customize): update document for using string.Template as message_template when jinja not installed
1 parent aa7bc28 commit 0286e7b

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

docs/customization.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,7 @@ message = "Do you want to add body message in commit?"
183183
| Parameter | Type | Default | Description |
184184
| --------- | ---- | ------- | ----------- |
185185
| `question` | `dict` | `None` | Questions regarding the commit message. Detatiled below. |
186-
| `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`. |
186+
| `message_template` | `str` | `None` | The template for generating message from the given answers. `message_template` should either follow the [string.Template](https://docs.python.org/3/library/string.html#template-strings) or [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`. Note that `Jinja2` is not installed by default. If not installed, commitizen will use `string.Template` formatting. |
187187
| `example` | `str` | `None` | (OPTIONAL) Provide an example to help understand the style. Used by `cz example`. |
188188
| `schema` | `str` | `None` | (OPTIONAL) Show the schema used. Used by `cz schema`. |
189189
| `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. |

0 commit comments

Comments
 (0)