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: add natspec-smells #56

Merged
merged 3 commits into from
Feb 1, 2024
Merged

feat: add natspec-smells #56

merged 3 commits into from
Feb 1, 2024

Conversation

dristpunk
Copy link
Contributor

Closes BES-236

Copy link

linear bot commented Jan 18, 2024

@dristpunk dristpunk self-assigned this Jan 18, 2024
package.json Outdated Show resolved Hide resolved
@gas1cent gas1cent requested a review from 0xJabberwock January 18, 2024 08:55
@@ -0,0 +1,9 @@
/**
* List of supported options: https://github.com/defi-wonderland/natspec-smells?tab=readme-ov-file#options
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Observation: constructorNatspec option is by default set to false. 🤔

Copy link
Member

@gas1cent gas1cent Jan 18, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@dristpunk let's see if most projects you have been testing the tool with have constructor natspec. I argue it's not that popular and hence the setting should be set to false even in our own projects.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we decided to leave it as it is for now

@gas1cent gas1cent requested review from 0xRaccoon and removed request for 0xGorilla January 30, 2024 20:27
@gas1cent gas1cent merged commit 97adec5 into main Feb 1, 2024
4 checks passed
@gas1cent gas1cent deleted the feat/natspec-smells branch February 1, 2024 12:53
xorsal pushed a commit that referenced this pull request Sep 27, 2024
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.

4 participants