1
0
mirror of https://github.com/mgechev/revive.git synced 2025-03-17 20:57:58 +02:00

documents unconditional-recursion

This commit is contained in:
chavacava 2020-05-09 17:19:37 +02:00
parent 91adb8bc8a
commit 4eb7ae0821
2 changed files with 9 additions and 0 deletions

View File

@ -350,6 +350,8 @@ List of all available rules. The rules ported from `golint` are left unchanged a
| [`cognitive-complexity`](./RULES_DESCRIPTIONS.md#cognitive-complexity) | int | Sets restriction for maximum Cognitive complexity. | no | no |
| [`string-of-int`](./RULES_DESCRIPTIONS.md#string-of-int) | n/a | Warns on suspicious casts from int to string | no | yes |
| [`early-return`](./RULES_DESCRIPTIONS.md#early-return) | n/a | Spots if-then-else statements that can be refactored to simplify code reading | no | no |
| [`unconditional-recursion`](./RULES_DESCRIPTIONS.md#unconditional-recursion) | n/a | Warns on function calls that will lead to (direct) infinite recursion | no | no |
## Configurable rules
Here you can find how you can configure some of the existing rules:

View File

@ -54,6 +54,7 @@ List of all available rules.
- [time-naming](#time-naming)
- [var-naming](#var-naming)
- [var-declaration](#var-declaration)
- [unconditional-recursion](#unconditional-recursion)
- [unexported-return](#unexported-return)
- [unhandled-error](#unhandled-error)
- [unnecessary-stmt](#unnecessary-stmt)
@ -482,6 +483,12 @@ _Description_: This rule proposes simplifications of variable declarations.
_Configuration_: N/A
## unconditional-recursion
_Description_: Unconditional recursive calls will produce infinite recursion, thus program stack overflow. This rule detect and warns about unconditional (direct) recursive calls.
_Configuration_: N/A
## unexported-return
_Description_: This rule warns when an exported function or method returns a value of an un-exported type.