feat(rules): add detect-missing-return-docs auditability detector#579
Merged
mijinummi merged 1 commit intoJun 30, 2026
Merged
Conversation
Adds auditability rule that flags functions with non-void return types lacking @return NatSpec comments. Closes MDTechLabs#343 Closes MDTechLabs#341 Closes MDTechLabs#340 Closes MDTechLabs#339
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Closes #343
Closes #341
Closes #340
Closes #339
Summary
Adds
rules/auditability/docs/detect-missing-return-docs.ts— flags functions with non-void return types that lack@returnNatSpec documentation.