Skip to content

Commit

Permalink
#1002 update documentation on exported rule
Browse files Browse the repository at this point in the history
  • Loading branch information
comdiv committed Jun 28, 2024
1 parent ecda17b commit 8f7a95a
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions RULES_DESCRIPTIONS.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ List of all available rules.
- [call-to-gc](#call-to-gc)
- [cognitive-complexity](#cognitive-complexity)
- [comment-spacings](#comment-spacings)
- [comments-density](#comment-spacings)
- [comments-density](#comments-density)
- [confusing-naming](#confusing-naming)
- [confusing-results](#confusing-results)
- [constant-logical-expr](#constant-logical-expr)
Expand Down Expand Up @@ -474,12 +474,13 @@ Available flags are:
* _checkPrivateReceivers_ enables checking public methods of private types
* _disableStutteringCheck_ disables checking for method names that stutter with the package name (i.e. avoid failure messages of the form _type name will be used as x.XY by other packages, and that stutters; consider calling this Y_)
* _sayRepetitiveInsteadOfStutters_ replaces the use of the term _stutters_ by _repetitive_ in failure messages
* _checkPublicInterface_ enabled checking public method definitions in public interface types

Example:

```toml
[rule.exported]
arguments = ["checkPrivateReceivers", "disableStutteringCheck"]
arguments = ["checkPrivateReceivers", "disableStutteringCheck", "checkPublicInterface"]
```

## file-header
Expand Down

0 comments on commit 8f7a95a

Please sign in to comment.