docs: add more tips around the analyzer #2913
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
Sec-ant
reviewed
May 18, 2024
Co-authored-by: Ze-Zheng Wu <[email protected]>
Sec-ant
approved these changes
May 19, 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.
Summary
More goodies around the analyzer.
All these will be updated soon once the analyzer infrastructure is done (there are still few more changes) and it will be ready for more rules.
As for now, I am assuming that the users are writing lint rules, however, we already say at the beginning that we have different kind of rules.
I added information regarding:
sourceandsource_kindactionAlso, I removed this
.mdfile from thebiome_analyzecrate because... well, it's to long and I think having it GitHub is more than enough. So I removed theignorecode block metadata.Test Plan
Proofread