Skip to content

Conversation

blaggacao
Copy link
Contributor

@blaggacao blaggacao commented Jun 9, 2020

fixes #202 - also fixes other inconsistencies which contributed to my initial confusion.

@blaggacao
Copy link
Contributor Author

blaggacao commented Jun 9, 2020

/cc @woile @Lee-W

| `name` | `str` | `None` | The key for the value answered by user. It's used in `message_template` |
| `message` | `str` | `None` | Detail description for the question. |
| `choices` | `list` | `None` | (OPTIONAL) The choices when `type = choice`. It should be list of dictionaries with `name` and `value`. (e.g., `[{value = "feature", name = "feature: A new feature."}, {value = "bug fix", name = "bug fix: A bug fix."}]`) |
| `choices` | `list` | `None` | (OPTIONAL) The choices when `type = list`. Either use a list of values or a list of dicitionaries with `name` and `value` keys. See examples above. |
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe define the proper type set supported by upstream library in this way.

@blaggacao
Copy link
Contributor Author

blaggacao commented Jun 9, 2020

Please squash-merge with proper commit message I just did a quick one-shot modification over github ui to fix what caused confusion. See: https://gist.github.com/piscisaureus/3342247 to attend such contributions more easily.

@Lee-W Lee-W merged commit f502e08 into commitizen-tools:master Jun 10, 2020
@Lee-W
Copy link
Member

Lee-W commented Jun 10, 2020

Thanks for updating! I just squahed and merged it.

@blaggacao blaggacao deleted the patch-1 branch June 10, 2020 02:56
@blaggacao
Copy link
Contributor Author

Super cool, I hope it's clearer now for future readers. Thx!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Feature Request] Contextual help on selections
2 participants