Skip to content

Commit 9320f7e

Browse files
bearomorphismLee-W
authored andcommitted
fix(cli): update description for deprecate warning
Closes #1135
1 parent b31e0cc commit 9320f7e

File tree

3 files changed

+4
-4
lines changed

3 files changed

+4
-4
lines changed

commitizen/cli.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ def __call__(
147147
{
148148
"name": ["-s", "--signoff"],
149149
"action": "store_true",
150-
"help": "sign off the commit",
150+
"help": "Deprecated, use 'cz commit -- -s' instead",
151151
},
152152
{
153153
"name": ["-a", "--all"],
@@ -347,7 +347,7 @@ def __call__(
347347
},
348348
{
349349
"name": ["--version-type"],
350-
"help": "Deprecated, use --version-scheme",
350+
"help": "Deprecated, use --version-scheme instead",
351351
"default": None,
352352
"choices": version_schemes.KNOWN_SCHEMES,
353353
},

tests/commands/test_bump_command/test_bump_command_shows_description_when_use_help_option.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ options:
7474
--version-scheme {pep440,semver,semver2}
7575
choose version scheme
7676
--version-type {pep440,semver,semver2}
77-
Deprecated, use --version-scheme
77+
Deprecated, use --version-scheme instead
7878
--build-metadata BUILD_METADATA
7979
Add additional build-metadata to the version-number
8080
--get-next Determine the next version and write to stdout

tests/commands/test_commit_command/test_commit_command_shows_description_when_use_help_option.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ options:
1212
--write-message-to-file FILE_PATH
1313
write message to file before committing (can be
1414
combined with --dry-run)
15-
-s, --signoff sign off the commit
15+
-s, --signoff Deprecated, use 'cz commit -- -s' instead
1616
-a, --all Tell the command to automatically stage files that
1717
have been modified and deleted, but new files you have
1818
not told Git about are not affected.

0 commit comments

Comments
 (0)