Add actual mypy error messages to documentation examples#20770
Open
veeceey wants to merge 1 commit intopython:masterfrom
Open
Add actual mypy error messages to documentation examples#20770veeceey wants to merge 1 commit intopython:masterfrom
veeceey wants to merge 1 commit intopython:masterfrom
Conversation
This change improves the googleability of mypy documentation by including actual error messages in the examples. When users encounter mypy errors, they can now more easily find relevant documentation by searching for the exact error message text. Changes made to docs/source/common_issues.rst: - Added actual error message for list invariance example (line 309) - Added actual error message for incompatible function argument example (line 332) - Added actual error message for incompatible method override examples (lines 729 and 739) Before: Comments like "# Error" or "mypy will complain about this" After: Full error messages like "# error: Incompatible types in assignment (expression has type ...)" This makes it easier for users to: 1. Search for error messages and find relevant documentation 2. Understand what error mypy will actually produce 3. Compare their errors with documented examples Fixes python#2393
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.
Summary
This PR improves the googleability of mypy documentation by including actual error messages in the examples. When users encounter mypy errors, they can now more easily find relevant documentation by searching for the exact error message text.
Changes
Made improvements to
docs/source/common_issues.rst:Before and After
Before
After
Benefits
Rationale
As mentioned in #2393, including actual error messages makes it much easier to Google for common mypy errors and find the relevant documentation. This is especially helpful for new users who may not know which section of the documentation addresses their specific error.
Fixes #2393