Skip to content

Commit 9cc0a82

Browse files
committed
docs(customization): detailed what a Questoin expect
1 parent f8e09ac commit 9cc0a82

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

docs/customization.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ commitizen:
140140
141141
| Parameter | Type | Default | Description |
142142
| ------------------- | ------ | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
143-
| `questions` | `Questions` | `None` | Questions regarding the commit message. Detailed below. The type `Questions` is an alias to `Iterable[MutableMapping[str, Any]]` which is definied in `commitizen.defaults`. |
143+
| `questions` | `Questions` | `None` | Questions regarding the commit message. Detailed below. The type `Questions` is an alias to `Iterable[MutableMapping[str, Any]]` which is definied in `commitizen.defaults`. It expects a list of dictionaries. |
144144
| `message_template` | `str` | `None` | The template for generating message from the given answers. `message_template` should either follow [Jinja2][jinja2] formatting specification, and all the variables in this template should be defined in `name` in `questions` |
145145
| `example` | `str` | `None` | (OPTIONAL) Provide an example to help understand the style. Used by `cz example`. |
146146
| `schema` | `str` | `None` | (OPTIONAL) Show the schema used. Used by `cz schema`. |
@@ -202,6 +202,7 @@ from commitizen.defaults import Questions
202202
203203
class JiraCz(BaseCommitizen):
204204
# Questions = Iterable[MutableMapping[str, Any]]
205+
# It expect a list with dictionaries.
205206
def questions(self) -> Questions:
206207
"""Questions regarding the commit message."""
207208
questions = [

0 commit comments

Comments
 (0)