Skip to content

Commit f1ac47b

Browse files
committed
wip
1 parent 30505d0 commit f1ac47b

File tree

3 files changed

+15
-11
lines changed

3 files changed

+15
-11
lines changed

docs/config/check.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,10 @@ List of prefixes that commitizen ignores when verifying messages.
1818

1919
## `message_length_limit`
2020

21-
Type: `int`
21+
- Type: `int`
22+
- Default: `0` (no limit)
2223

23-
Default: `0`
24+
Maximum length of the commit message. Setting it to `0` disables the length limit.
2425

25-
Maximum length of the commit message. Setting it to `0` disables the length limit. It can be overridden by the `-l/--message-length-limit` command line argument.
26+
!!! note
27+
This option can be overridden by the `-l/--message-length-limit` command line argument.

docs/config/commit.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,4 +23,4 @@ Sets the character encoding to be used when parsing commit messages.
2323
- Type: `bool`
2424
- Default: `False`
2525

26-
Automatically retry failed commit when running `cz commit`.
26+
Retries failed commit when running `cz commit`.

docs/config/option.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,38 @@
11
# Misc Options
22

3-
### `name`
3+
## `name`
44

55
- Type: `str`
66
- Default: `"cz_conventional_commits"`
77

88
Name of the committing rules to use.
99

10-
### `version`
10+
## `version`
1111

1212
- Type: `str`
1313
- Default: `None`
1414

1515
Current version. Example: `"0.1.2"`. Required if you use `version_provider = "commitizen"`.
1616

17-
### `style`
17+
## `style`
1818

1919
- Type: `list`
2020
- Default: `[]`
2121

2222
Style for the prompts (It will merge this value with default style.) See [Styling your prompts with your favorite colors](https://github.com/tmbo/questionary#additional-features) for more details.
2323

24-
### `customize`
24+
## `customize`
2525

2626
- Type: `dict`
2727
- Default: `None`
2828

29-
**This is only supported when config through `toml`.** Custom rules for committing and bumping. See [customization](../customization.md) for more details.
29+
**This is only supported when config through `toml` configuration file.**
3030

31-
### `use_shortcuts`
31+
Custom rules for committing and bumping. See [customization](../customization.md) for more details.
32+
33+
## `use_shortcuts`
3234

3335
- Type: `bool`
3436
- Default: `False`
3537

36-
If enabled, Commitizen will show keyboard shortcuts when selecting from a list. Define a `key` for each of your choices to set the key. See [shortcut keys](../customization.md#shortcut-keys) for more details.
38+
Show keyboard shortcuts when selecting from a list. Define a `key` for each of your choices to set the key. See [shortcut keys](../customization.md#shortcut-keys) for more details.

0 commit comments

Comments
 (0)