Skip to content

Commit 3debb75

Browse files
committed
fix: improper enforcement of natspec rule on internals
1 parent b731867 commit 3debb75

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

docs/rules/best-practices/use-natspec.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,8 @@ This rule accepts an array of options:
5757
```
5858

5959
### Notes
60+
- For `internal` or `private` function this rule checks natspec as configured, only if there are tags present. If not, function is skipped.
61+
- For `external` or `public` function this rule checks natspec as specified in the config.
6062
- If a function or return value has unnamed parameters (e.g. `function foo(uint256)`), the rule only checks the number of `@param` or `@return` tags, not their names.
6163
- If a function or variable has `@inheritdoc`, the rule skips the validation.
6264
- The rule supports both `///` and `/** */` style NatSpec comments.

0 commit comments

Comments
 (0)