Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: allow enforcing natspec on specific items #42

Merged
merged 12 commits into from
Feb 24, 2025
Merged

Conversation

beeb
Copy link
Owner

@beeb beeb commented Feb 24, 2025

A new CLI argument and config item allows to specify whether @dev or @notice elements must be present on items which do not have other requirements (like the need for documenting a parameter, return value or struct/enum member).

@beeb beeb changed the title fix(variable)!: raise error on missing natspec feat: allow enforcing natspec on specific items Feb 24, 2025
@beeb beeb merged commit 7d9a5b3 into main Feb 24, 2025
12 checks passed
@beeb beeb deleted the error-on-missing-natspec branch February 24, 2025 08:52
@beeb-release-plz beeb-release-plz bot mentioned this pull request Feb 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant