Skip to content

Commit f2ac1c1

Browse files
committed
docs(message_length_limit): document non-negative limit
1 parent 67db626 commit f2ac1c1

File tree

2 files changed

+12
-0
lines changed

2 files changed

+12
-0
lines changed

docs/config/check.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ List of prefixes that commitizen ignores when verifying messages.
2222
- Default: `0` (no limit)
2323

2424
Maximum length of the commit message. Setting it to `0` disables the length limit.
25+
This value must be a non-negative integer (`>= 0`).
2526

2627
!!! note
2728
This option can be overridden by the `-l/--message-length-limit` command line argument.

docs/config/commit.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,3 +24,14 @@ Sets the character encoding to be used when parsing commit messages.
2424
- Default: `False`
2525

2626
Retries failed commit when running `cz commit`.
27+
28+
## `message_length_limit`
29+
30+
- Type: `int`
31+
- Default: `0` (no limit)
32+
33+
Maximum length of the commit message. Setting it to `0` disables the length limit.
34+
This value must be a non-negative integer (`>= 0`).
35+
36+
!!! note
37+
This option can be overridden by the `-l/--message-length-limit` command line argument.

0 commit comments

Comments
 (0)