Show additional information when a hook fails #3190
Closed
Conversation
This file contains 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
…able. When developers run the pre-commit, they don't always understand what to or where to find more information. The hook description field is already present and often used to provide more descriptive information. For brevity this is not shown in normal cases, but this PR changes the tool behavior to show the description in verbose mode (`-v`). So most users won't see any difference but this can easily be enabled for people who want it. Alternatives considered: * Always show the description: Some people may not like this though as it can be spammy. * Provide a new field: Possible but seems to be just more work with description already present and not otherwise used. * Show the `repo` link. This is at the wrong level and has a slightly different purpose. Though description can just be set to the same url where that is correct.
The original `_handle_readonly` was flagged as not returning `object` even though the actual shutl.rmtree` does not use a return value. So here we actually follow the requirements as seen by mymy iterally (which the local mymp in venv confirms to be correct).
…. So we apply a cast for this to work.
|
please don't waste time on implementation until a feature is agreed on |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Possible implementation for #3189
When
runis called with-v, then showhook.descriptionif available.When developers run the pre-commit, they don't always understand what to or where to find more information. The hook description field is already present and often used to provide more descriptive information. For brevity this is not shown in normal cases, but this PR changes the tool behavior to show the description in verbose mode (
-v). So most users won't see any difference but this can easily be enabled for people who want it.Alternatives considered:
repolink. This is at the wrong level and has a slightly different purpose. Though description can just be set to the same url where that is correct.