Documentation for Exceptions RuleSet #640
Merged
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
schalkms
approved these changes
Dec 24, 2017
| TODO: Specify description | ||
| This rule reports `catch` blocks for exceptions that have a type that is too generic. | ||
| It should be preferred to catch specific exceptions to the case that is currently handled. If the scope of the caught | ||
| Exception is too broad it can lead to unintended exceptions being caught. |
| This rule allows to define functions which should never throw an exception. If a function exists that does throw | ||
| an exception it will be reported. By default this rule is checking for `toString`, `hashCode, `equals` and | ||
| `finalize`. This rule is configurable via the `methodNames` configuration to change the list of functions which | ||
| should not throw. |
| @@ -194,7 +206,10 @@ fun foo() { | |||
|
|
|||
| ### ThrowingExceptionsWithoutMessageOrCause | |||
|
|
|||
| TODO: Specify description | |||
| This rule reports all exceptions which are thrown without arguments or further description. | |||
| Exceptions should always call one of the constructor overloads to provide a message or a cause exception. | |||
| This rule reports all exceptions which are thrown without arguments or further description. | ||
| Exceptions should always call one of the constructor overloads to provide a message or a cause exception. | ||
| Exceptions should be meaningful and contain as much detail about the error case as possible. This will help track | ||
| down an underlying issue in a better way. |
vanniktech
approved these changes
Dec 24, 2017
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.
Adds documentation for all rules in the exceptions RuleSet.
Relates to #496