docs: change readme #28
Merged
Conversation
This file contains 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
gas1cent
reviewed
Feb 8, 2024
README.md
Outdated
| ``` | ||
|
|
||
| **Please note** that the `--include` and `--exclude` parameters accept a glob string as input. Therefore, it is necessary to enclose these strings in quotes. |
There was a problem hiding this comment.
How about a highlight?
Suggested change
| **Please note** that the `--include` and `--exclude` parameters accept a glob string as input. Therefore, it is necessary to enclose these strings in quotes. | |
| > [!NOTE] | |
| > Remember to put quotes around the glob strings when using the `include` and `exclude` options. |
gas1cent
reviewed
Feb 8, 2024
README.md
Outdated
| @@ -40,8 +42,8 @@ npx @defi-wonderland/natspec-smells --include solidity --exclude solidity/(test| | |||
|
|
|||
| /** @type {import('@defi-wonderland/natspec-smells').Config} */ | |||
| module.exports = { | |||
| include: "solidity", | |||
| exclude: ["solidity/(test|scripts)/**/*.sol"], | |||
| include: "src/**/*.sol", | |||
There was a problem hiding this comment.
Should be single quotes I think due to our linter rules.
gas1cent
approved these changes
Feb 14, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
🤖 Linear
Closes BES-262