Add 'how the lint is implemented' documentation to missing-owner-check lint #74
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
|
Added documentation to all other lints. The documentation for |
S3v3ru5
force-pushed
the
fix-include-key-checks
branch
from
736a4d3
to
236b611
Compare
S3v3ru5
force-pushed
the
add-documentation
branch
from
e82b2e6
to
ad7dfc9
Compare
added 4 commits
February 8, 2024 19:32
S3v3ru5
force-pushed
the
add-documentation
branch
from
ad7dfc9
to
0af9f04
Compare
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.
Added inline documentation to the
missing-owner-checklint. Also addedHow the lint is implementeddocumentation.The
How the lint is implementedshould give an overview of implementation: What parts of the code are checked, which are ignored and why, etc. Themissing-owner-checkshould be a good example.Aside: The
scripts/update_readmes.shfails on my Mac; I think its the case for other OSX as well.failure reason:
Using the
gsed(brew install gnu-sed) for the failing command worked. We should probably update the script so that it works with bothgnu-sedand OSXsed.Creating a draft pull request as I will be adding documentation for other lints as well.