Add documentation on pylint/mypy checker overlap#15404
Draft
JennyPng wants to merge 1 commit intoAzure:mainfrom
Draft
Add documentation on pylint/mypy checker overlap#15404JennyPng wants to merge 1 commit intoAzure:mainfrom
JennyPng wants to merge 1 commit intoAzure:mainfrom
Conversation
Addresses Azure#3226. Adds a section to README.md documenting the overlap between pylint custom checkers and mypy, with a comparison table and recommendations for when to use each tool. Conclusion: there is minimal actual overlap - most pylint rules check SDK-specific conventions that mypy cannot enforce. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
e92fda4 to
ae1902b
Compare
Collaborator
|
The following pipelines have been queued for testing: |
This file contains hidden or 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
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.
Fixes #3226
Adds documentation analyzing the overlap between custom pylint checkers and mypy, with a comparison table and recommendations.
Key Finding
There is minimal actual overlap — most pylint rules check SDK-specific conventions (docstrings, naming, imports) that mypy cannot enforce. The two tools are complementary.
Changes