docs(exit-codes): general update and add docstring to exceptions.py #1662
+108
−36
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bearomorphism
requested review from
Lee-W,
noirbizarre and
woile
as code owners
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## v4-10-1 #1662 +/- ##
==========================================
Coverage ? 98.60%
==========================================
Files ? 60
Lines ? 2650
Branches ? 0
==========================================
Hits ? 2613
Misses ? 37
Partials ? 0
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
bearomorphism
force-pushed
the
doc-exit
branch
2 times, most recently
from
bf1fca1 to
08f521a
Compare
bearomorphism
changed the title
docs(exception): add comment for updating exit code doc
bearomorphism
force-pushed
the
doc-exit
branch
from
08f521a to
b7b09bc
Compare
Lee-W
reviewed
Nov 21, 2025
|
|
||
|
|
||
| class CurrentVersionNotFoundError(CommitizenException): | ||
| """current version cannot be found in _version_files_""" |
Member
There was a problem hiding this comment.
Suggested change
| """current version cannot be found in _version_files_""" | |
| """Current version cannot be found in `version_files`""" |
|
|
||
|
|
||
| class InitFailedError(CommitizenException): | ||
| """Failed to initialize pre-commit""" |
Member
There was a problem hiding this comment.
Could it be other issue with cz init?
| | `CurrentVersionNotFoundError`| 17 | Current version cannot be found in _version_files_ | | ||
| | `InvalidCommandArgumentError`| 18 | The argument provided to the command is invalid (e.g. `cz check -commit-msg-file filename --rev-range master..`) | | ||
| | `InvalidConfigurationError` | 19 | An error was found in the Commitizen Configuration, such as duplicates in `change_type_order` | | ||
| | `NotAllowed` | 20 | `--incremental` cannot be combined with a `rev_range` | |
Contributor
Author
There was a problem hiding this comment.
No. I can update the description like "Invalid combination of command line / configuration file options"
Member
|
nice! LGTM! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Update outdated information, fix grammar mistakes, add error codes, etc.